Compartilhar via

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

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.
calculationState

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

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

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.
decimalSeparator

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

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.
thousandsSeparator

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.
useSystemSeparators

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

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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

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

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

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

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.

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

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

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

Comentários

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

calculationState

Retorna o estado de cálculo do aplicativo. Veja Excel.CalculationState para obter 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 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

Excel.RequestContext

cultureInfo

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

Excel.CultureInfo

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

decimalSeparator

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

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

iterativeCalculation

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

Excel.IterativeCalculation

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

thousandsSeparator

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

string

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

useSystemSeparators

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

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. Veja Excel.CalculationType para obter 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. Veja Excel.CalculationType para obter 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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.Application

set(properties, options)

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

properties
Excel.Interfaces.ApplicationUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.Application): void;

Parâmetros

properties
Excel.Application

Retornos

void

suspendApiCalculationUntilNextSync()

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

void

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

suspendScreenUpdatingUntilNextSync()

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

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 é 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

Excel.Interfaces.ApplicationData