Excel.Application class

  • Referência
Pacote:
excel

Representa o aplicativo Excel que gerencia a pasta de trabalho.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

calculationEngineVersion

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

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; AutomaticExceptTables, em que o Excel controla o recálculo, mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o usuário solicita.
calculationState

Retorna o estado de cálculo do aplicativo. Confira Excel.CalculationState detalhes.
context

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

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

Obtém a cadeia de caracteres usada como separador decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
formatStaleValues

Especifica se a opção Formatar Valores Obsoletos em Opções de Cálculo está habilitada ou desabilitada. As fórmulas obsoletas serão renderizadas com formatação obsoleta se a opção estiver habilitada.
iterativeCalculation

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

Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
useSystemSeparators

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

Métodos

calculate(calculationType)

Recalcula todas as pastas de trabalho abertas no Excel no momento.
calculate(calculationTypeString)

Recalcula todas as pastas de trabalho abertas no Excel no momento.
load(options)

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

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

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

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)

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

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.
suspendScreenUpdatingUntilNextSync()

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

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

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

Detalhes da propriedade

calculationEngineVersion

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

readonly calculationEngineVersion: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

calculationMode

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; AutomaticExceptTables, em que o Excel controla o recálculo, mas ignora as alterações nas tabelas; Manual, onde o cálculo é feito quando o usuário solicita.

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

Valor da propriedade

Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"

Comentários

[ Conjunto de API: ExcelApi 1.1 para obter, 1.8 para conjunto ]

calculationState

Retorna o estado de cálculo do aplicativo. Confira Excel.CalculationState detalhes.

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

Valor da propriedade

Excel.CalculationState | "Done" | "Calculating" | "Pending"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

context

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

Excel.RequestContext

cultureInfo

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

readonly cultureInfo: Excel.CultureInfo;

Valor da propriedade

Excel.CultureInfo

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

decimalSeparator

Obtém a cadeia de caracteres usada como separador decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.

readonly decimalSeparator: string;

Valor da propriedade

string

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();
});

formatStaleValues

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se a opção Formatar Valores Obsoletos em Opções de Cálculo está habilitada ou desabilitada. As fórmulas obsoletas serão renderizadas com formatação obsoleta se a opção estiver habilitada.

formatStaleValues: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

iterativeCalculation

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

readonly iterativeCalculation: Excel.IterativeCalculation;

Valor da propriedade

Excel.IterativeCalculation

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

thousandsSeparator

Obtém a cadeia de caracteres usada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.

readonly thousandsSeparator: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

useSystemSeparators

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

readonly useSystemSeparators: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Detalhes do método

calculate(calculationType)

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

calculate(calculationType: Excel.CalculationType): void;

Parâmetros

calculationType
Excel.CalculationType

Especifica o tipo de cálculo a usar. Confira Excel.CalculationType detalhes.

Retornos

void

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);
});

calculate(calculationTypeString)

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

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

Parâmetros

calculationTypeString

"Recalculate" | "Full" | "FullRebuild"

Especifica o tipo de cálculo a usar. Confira Excel.CalculationType detalhes.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

load(options)

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

options
Excel.Interfaces.ApplicationLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.Application

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.Application

Exemplos

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

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Application

set(properties, options)

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

properties
Excel.Interfaces.ApplicationUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

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

set(properties: Excel.Application): void;

Parâmetros

properties
Excel.Application

Retornos

void

suspendApiCalculationUntilNextSync()

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

void

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

suspendScreenUpdatingUntilNextSync()

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

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

suspendScreenUpdatingUntilNextSync(): void;

Retornos

void

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://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`);
});

toJSON()

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

toJSON(): Excel.Interfaces.ApplicationData;

Retornos

Excel.Interfaces.ApplicationData