ExcelScript.Application interface

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

calculate(calculationType: CalculationType): void;

Parâmetros

Retornos

Exemplos

/**
 * This script fully recalculates the entire workbook.
 * This code is useful when automatic recalculation is turned off
 * but later parts of the script rely on updated values.
 */
function main(workbook: ExcelScript.Workbook, workbookURL: string) {
  const application = workbook.getApplication();
  application.calculate(ExcelScript.CalculationType.fullRebuild);
}

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

getCalculationEngineVersion(): number;

Retornos

Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas constantes em ExcelScript.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.

getCalculationMode(): CalculationMode;

Retornos

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

getCalculationState(): CalculationState;

Retornos

Exemplos

/**
 * This script uses the fill color of the first cell to indicate the current
 * calculation state of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the first worksheet.
  const cell = workbook.getWorksheets()[0].getCell(0,0);

  // Get that cell's fill object.
  const cellFill = cell.getFormat().getFill();

  // Set the cell fill based on the calculation state.
  const calcState = workbook.getApplication().getCalculationState();
  switch (calcState) {
    case ExcelScript.CalculationState.pending:
      cellFill.setColor("Red");
      break;
    case ExcelScript.CalculationState.calculating:
      cellFill.setColor("Yellow");
      break;
    case ExcelScript.CalculationState.done:
      cellFill.setColor("Green");
      break;
  }
}

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

getCultureInfo(): CultureInfo;

Retornos

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

getDecimalSeparator(): string;

Retornos

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.

getIterativeCalculation(): IterativeCalculation;

Retornos

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.

getThousandsSeparator(): string;

Retornos

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

getUseSystemSeparators(): boolean;

Retornos

Retorna o modo de cálculo usado na pasta de trabalho, conforme definido pelas constantes em ExcelScript.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.

setCalculationMode(calculationMode: CalculationMode): void;

Parâmetros

Retornos