ExcelScript.Application interface

Pacote:

ExcelScript

Representa o aplicativo Excel que gerencia a pasta de trabalho.

Métodos

calculate(calculationType)	Recalcula todas as pastas de trabalho abertas no Excel no momento.
getCalculationEngineVersion()	Retorna a versão do mecanismo de cálculo do Excel usada para o último recálculo completo.
getCalculationMode()	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; 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.
getCalculationState()	Retorna o estado de cálculo do aplicativo. Confira ExcelScript.CalculationState detalhes.
getCultureInfo()	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.
getDecimalSeparator()	Obtém a cadeia de caracteres usada como separador decimal para valores numéricos. Isso se baseia nas configurações locais do Excel.
getIterativeCalculation()	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.
getThousandsSeparator()	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.
getUseSystemSeparators()	Especifica se os separadores do sistema do Excel estão habilitados. Os separadores do sistema incluem o separador decimal e milhares de separadores.
setCalculationMode(calculationMode)	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; 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.

Detalhes do método

calculate(calculationType)

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

calculate(calculationType: CalculationType): void;

Parâmetros

calculationType

ExcelScript.CalculationType

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

Retornos

void

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

getCalculationEngineVersion()

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

getCalculationEngineVersion(): number;

Retornos

number

getCalculationMode()

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

getCalculationMode(): CalculationMode;

Retornos

ExcelScript.CalculationMode

getCalculationState()

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

getCalculationState(): CalculationState;

Retornos

ExcelScript.CalculationState

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

getCultureInfo()

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.

getCultureInfo(): CultureInfo;

Retornos

ExcelScript.CultureInfo

getDecimalSeparator()

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

string

getIterativeCalculation()

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.

getIterativeCalculation(): IterativeCalculation;

Retornos

ExcelScript.IterativeCalculation

getThousandsSeparator()

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

string

getUseSystemSeparators()

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

getUseSystemSeparators(): boolean;

Retornos

boolean

setCalculationMode(calculationMode)

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

setCalculationMode(calculationMode: CalculationMode): void;

Parâmetros

calculationMode

ExcelScript.CalculationMode

Retornos

void