ExcelScript.Application interface

Пакет:

ExcelScript

Представляет приложение Excel, которое управляет книгой.

Методы

calculate(calculationType)	Пересчитывает данные во всех открытых в текущий момент книгах Excel.
getCalculationEngineVersion()	Возвращает версию модуля вычислений Excel, использованного для последнего полного пересчета.
getCalculationMode()	Возвращает режим вычисления, используемый в книге, как определено константами в ExcelScript.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом;AutomaticExceptTables , где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где вычисление выполняется, когда пользователь запрашивает его.
getCalculationState()	Возвращает состояние вычисления приложения. Дополнительные сведения см. в этой ExcelScript.CalculationState статье.
getCultureInfo()	Предоставляет сведения на основе текущих параметров языка и региональных параметров системы. Сюда входят имена и региональные параметры, форматирование чисел и другие параметры, зависящие от культуры.
getDecimalSeparator()	Возвращает строку, используемую в качестве десятичного разделителя для числовых значений. Это зависит от локальных параметров Excel.
getIterativeCalculation()	Возвращает параметры итеративного вычисления. В Excel для Windows и Mac параметры будут применяться к приложению Excel. На Excel в Интернете и других платформах параметры будут применяться к активной книге.
getThousandsSeparator()	Возвращает строку, используемую для разделения групп цифр слева от десятичного числа для числовых значений. Это зависит от локальных параметров Excel.
getUseSystemSeparators()	Указывает, включены ли системные разделители Excel. Системные разделители включают десятичный разделитель и разделитель тысяч.
setCalculationMode(calculationMode)	Возвращает режим вычисления, используемый в книге, как определено константами в ExcelScript.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом;AutomaticExceptTables , где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где вычисление выполняется, когда пользователь запрашивает его.

Сведения о методе

calculate(calculationType)

Пересчитывает данные во всех открытых в текущий момент книгах Excel.

calculate(calculationType: CalculationType): void;

Параметры

calculationType

ExcelScript.CalculationType

Определяет тип расчета, который нужно использовать. Дополнительные сведения см. в этой ExcelScript.CalculationType статье.

Возвращаемое значение

void

Примеры

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

Возвращает версию модуля вычислений Excel, использованного для последнего полного пересчета.

getCalculationEngineVersion(): number;

Возвращаемое значение

number

getCalculationMode()

Возвращает режим вычисления, используемый в книге, как определено константами в ExcelScript.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом;AutomaticExceptTables , где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где вычисление выполняется, когда пользователь запрашивает его.

getCalculationMode(): CalculationMode;

Возвращаемое значение

ExcelScript.CalculationMode

getCalculationState()

Возвращает состояние вычисления приложения. Дополнительные сведения см. в этой ExcelScript.CalculationState статье.

getCalculationState(): CalculationState;

Возвращаемое значение

ExcelScript.CalculationState

Примеры

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

Предоставляет сведения на основе текущих параметров языка и региональных параметров системы. Сюда входят имена и региональные параметры, форматирование чисел и другие параметры, зависящие от культуры.

getCultureInfo(): CultureInfo;

Возвращаемое значение

ExcelScript.CultureInfo

getDecimalSeparator()

Возвращает строку, используемую в качестве десятичного разделителя для числовых значений. Это зависит от локальных параметров Excel.

getDecimalSeparator(): string;

Возвращаемое значение

string

getIterativeCalculation()

Возвращает параметры итеративного вычисления. В Excel для Windows и Mac параметры будут применяться к приложению Excel. На Excel в Интернете и других платформах параметры будут применяться к активной книге.

getIterativeCalculation(): IterativeCalculation;

Возвращаемое значение

ExcelScript.IterativeCalculation

getThousandsSeparator()

Возвращает строку, используемую для разделения групп цифр слева от десятичного числа для числовых значений. Это зависит от локальных параметров Excel.

getThousandsSeparator(): string;

Возвращаемое значение

string

getUseSystemSeparators()

Указывает, включены ли системные разделители Excel. Системные разделители включают десятичный разделитель и разделитель тысяч.

getUseSystemSeparators(): boolean;

Возвращаемое значение

boolean

setCalculationMode(calculationMode)

Возвращает режим вычисления, используемый в книге, как определено константами в ExcelScript.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом;AutomaticExceptTables , где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где вычисление выполняется, когда пользователь запрашивает его.

setCalculationMode(calculationMode: CalculationMode): void;

Параметры

calculationMode

ExcelScript.CalculationMode

Возвращаемое значение

void