ExcelScript.Application interface

Paquete:

ExcelScript

Representa la aplicación de Excel que administra el libro.

Métodos

calculate(calculationType)	Recalcula todos los libros abiertos actualmente en Excel.
getCalculationEngineVersion()	Devuelve la versión del motor de cálculo de Excel usada para la última actualización completa.
getCalculationMode()	Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de ExcelScript.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.
getCalculationState()	Devuelve el estado del cálculo de la aplicación. Vea ExcelScript.CalculationState para más información.
getCultureInfo()	Proporciona información basada en la configuración actual de la referencia cultural del sistema. Esto incluye los nombres de referencia cultural, el formato de números y otras configuraciones culturalmente dependientes.
getDecimalSeparator()	Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración local de Excel.
getIterativeCalculation()	Devuelve la configuración de cálculo iterativo. En Excel en Windows y Mac, la configuración se aplicará a la aplicación de Excel. En Excel en la Web y otras plataformas, la configuración se aplicará al libro activo.
getThousandsSeparator()	Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración local de Excel.
getUseSystemSeparators()	Especifica si los separadores del sistema de Excel están habilitados. Los separadores del sistema incluyen el separador decimal y el separador de miles.
setCalculationMode(calculationMode)	Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de ExcelScript.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.

Detalles del método

calculate(calculationType)

Recalcula todos los libros abiertos actualmente en Excel.

calculate(calculationType: CalculationType): void;

Parámetros

calculationType

ExcelScript.CalculationType

Especifica el tipo de cálculo que se va a usar. Vea ExcelScript.CalculationType para más información.

Devoluciones

void

Ejemplos

/**
 * 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()

Devuelve la versión del motor de cálculo de Excel usada para la última actualización completa.

getCalculationEngineVersion(): number;

Devoluciones

number

getCalculationMode()

Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de ExcelScript.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.

getCalculationMode(): CalculationMode;

Devoluciones

ExcelScript.CalculationMode

getCalculationState()

Devuelve el estado del cálculo de la aplicación. Vea ExcelScript.CalculationState para más información.

getCalculationState(): CalculationState;

Devoluciones

ExcelScript.CalculationState

Ejemplos

/**
 * 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()

Proporciona información basada en la configuración actual de la referencia cultural del sistema. Esto incluye los nombres de referencia cultural, el formato de números y otras configuraciones culturalmente dependientes.

getCultureInfo(): CultureInfo;

Devoluciones

ExcelScript.CultureInfo

getDecimalSeparator()

Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración local de Excel.

getDecimalSeparator(): string;

Devoluciones

string

getIterativeCalculation()

Devuelve la configuración de cálculo iterativo. En Excel en Windows y Mac, la configuración se aplicará a la aplicación de Excel. En Excel en la Web y otras plataformas, la configuración se aplicará al libro activo.

getIterativeCalculation(): IterativeCalculation;

Devoluciones

ExcelScript.IterativeCalculation

getThousandsSeparator()

Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración local de Excel.

getThousandsSeparator(): string;

Devoluciones

string

getUseSystemSeparators()

Especifica si los separadores del sistema de Excel están habilitados. Los separadores del sistema incluyen el separador decimal y el separador de miles.

getUseSystemSeparators(): boolean;

Devoluciones

boolean

setCalculationMode(calculationMode)

Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de ExcelScript.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.

setCalculationMode(calculationMode: CalculationMode): void;

Parámetros

calculationMode

ExcelScript.CalculationMode

Devoluciones

void