Excel.Application class

Retorna a versão do mecanismo de cálculo do Excel usada para o último recálculo completo.

readonly calculationEngineVersion: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas constantes em Excel.CalculationMode. Os valores possíveis são: Automatic, em que o Excel controla o recálculo; , em que o Excel controla o recálculo,AutomaticExceptTables mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o usuário o solicita. Essa é uma propriedade de runtime. A calculationMode configuração não é mantida na pasta de trabalho.

calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1 para obter, 1.8 para definir

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-calculation.yaml

await Excel.run(async (context) => {
  context.application.calculationMode = Excel.CalculationMode.manual;
  context.application.load("calculationMode");
  await context.sync();

  console.log("Current calculation mode: " + context.application.calculationMode);
});

Retorna o estado de cálculo do aplicativo. Consulte Excel.CalculationState para obter detalhes.

readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Retorna as configurações de cálculo iterativo. No Excel no Windows e Mac, as configurações serão aplicadas ao aplicativo Excel. No Excel na Web e em outras plataformas, as configurações serão aplicadas à pasta de trabalho ativa.

readonly iterativeCalculation: Excel.IterativeCalculation;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Recalcula todas as pastas de trabalho abertas no Excel no momento.

calculate(calculationType: Excel.CalculationType): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  context.application.calculate(Excel.CalculationType.full);
});

Recalcula todas as pastas de trabalho abertas no Excel no momento.

calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => {
    context.workbook.application.calculate('Full');
    await context.sync();
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.Application;

Parâmetros

Retornos

Exemplos

await Excel.run(async (context) => {
    const application = context.workbook.application;
    application.load('calculationMode');
    await context.sync();

    console.log(application.calculationMode);
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Application;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Application): void;

Parâmetros

Retornos

Suspende o cálculo até que o próximo context.sync() seja chamado. Uma vez definido, é responsabilidade do desenvolvedor recalcular a pasta de trabalho, para garantir que todas as dependências sejam propagadas.

suspendApiCalculationUntilNextSync(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.6

Suspende a atualização da tela até que a próxima context.sync() seja chamada.

Observação: não ligue suspendScreenUpdatingUntilNextSync repetidamente (como em um loop). Chamadas repetidas farão com que a janela do Excel pisque.

suspendScreenUpdatingUntilNextSync(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  // Recreate the data in the worksheet with random data.
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  const startTime = Date.now();
  console.log("Starting...");

  // If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called.
  if (pauseScreenPainting) {
    context.application.suspendScreenUpdatingUntilNextSync();
  }

  for (let i = 1; i < ROW_COUNT; i++) {
    for (let j = 1; j < COLUMN_COUNT; j++) {
      let cell = sheet.getCell(i, j);
      cell.values = [[i * j * Math.random()]];

      // If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects.
      // For more information, see https://learn.microsoft.com/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects
      if (untrack) {
        cell.untrack();
      }
    }
  }

  await context.sync();

  console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`);
});

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Application é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ApplicationData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ApplicationData;

Retornos