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 API: ExcelApi 1.9 ]

Devolve o modo de cálculo utilizado no livro, conforme definido pelas constantes em Excel.CalculationMode. Os valores possíveis são: Automatic, em que o Excel controla o recálculo; AutomaticExceptTables, em que o Excel controla o recálculo, mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o utilizador o pede.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 para get, 1.8 para set ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Fornece informações com base nas definições atuais da cultura do sistema. Isto inclui os nomes de cultura, a formatação de números e outras definições culturalmente dependentes.

readonly cultureInfo: Excel.CultureInfo;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Obtém a cadeia utilizada como separador decimal para valores numéricos. Isto baseia-se nas definições locais do Excel.

readonly decimalSeparator: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Exemplos

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

await Excel.run(async (context) => {
  context.application.load("decimalSeparator,thousandsSeparator");
  context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator");
  await context.sync();

  // Local settings are set under the "Options > Advanced" menu.
  const localDecimalSeparator = context.application.decimalSeparator;
  const localThousandsSeparator = context.application.thousandsSeparator;

  const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
  const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;

  console.log("Local character settings: ");
  console.log(`  Local decimal separator: ${localDecimalSeparator}`);
  console.log(`  Local thousands separator: ${localThousandsSeparator}`);

  console.log("System culture settings: ");
  console.log(`  System decimal separator: ${systemDecimalSeparator}`);
  console.log(`  System thousands separator: ${systemThousandsSeparator}`);
  console.log(`  `);

  await context.sync();
});

Especifica se a opção Formatar Valores Obsoletos nas Opções de Cálculo está ativada ou desativada. As fórmulas obsoletas são compostas com formatação obsoleto se a opção estiver ativada.

formatStaleValues: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Devolve as definições de cálculo iterativo. No Excel no Windows e Mac, as definições serão aplicadas à Aplicação do Excel. No Excel na Web e noutras plataformas, as definições serão aplicadas ao livro ativo.

readonly iterativeCalculation: Excel.IterativeCalculation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Obtém a cadeia utilizada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isto baseia-se nas definições locais do Excel.

readonly thousandsSeparator: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Especifica se os separadores de sistema do Excel estão ativados. Os separadores de sistema incluem o separador decimal e o separador de milhares.

readonly useSystemSeparators: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

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

calculate(calculationType: Excel.CalculationType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 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(calculationTypeString: "Recalculate" | "Full" | "FullRebuild"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: 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. Pode transmitir um objeto simples com as propriedades adequadas 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 num objeto carregado existente.

set(properties: Excel.Application): void;

Parâmetros

Retornos

Suspende o cálculo até ser chamado o seguinte context.sync() . 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 API: ExcelApi 1.6 ]

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

Nota*: não chame suspendScreenUpdatingUntilNextSync repetidamente (por exemplo, num ciclo). As chamadas repetidas farão com que a janela do Excel cintile.

suspendScreenUpdatingUntilNextSync(): void;

Retornos

Comentários

[ Conjunto de API: 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://video2.skills-academy.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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Application é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ApplicationData;

Retornos