Поделиться через


Excel.Application class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

calculationEngineVersion

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

calculationMode

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

calculationState

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

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

cultureInfo

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

decimalSeparator

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

iterativeCalculation

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

thousandsSeparator

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

useSystemSeparators

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

Методы

calculate(calculationType)

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

calculate(calculationTypeString)

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

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

suspendApiCalculationUntilNextSync()

Приостанавливает вычисление до вызова следующего context.sync() . После этого за пересчет книги и распространение всех зависимостей несет ответственность разработчик.

suspendScreenUpdatingUntilNextSync()

Приостанавливает обновление экрана до вызова следующего context.sync() .

Примечание*. Не вызывайте suspendScreenUpdatingUntilNextSync повторно (например, в цикле). При повторных вызовах окно Excel будет мерцать.

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Application является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ApplicationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

calculationEngineVersion

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

readonly calculationEngineVersion: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

calculationMode

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

calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

Значение свойства

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

Комментарии

[ Набор API: ExcelApi 1.1 для get, 1.8 для набора ]

calculationState

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

readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";

Значение свойства

Excel.CalculationState | "Done" | "Calculating" | "Pending"

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

cultureInfo

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

readonly cultureInfo: Excel.CultureInfo;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.11 ]

decimalSeparator

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

readonly decimalSeparator: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.11 ]

Примеры

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

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

readonly iterativeCalculation: Excel.IterativeCalculation;

Значение свойства

Комментарии

[ Набор API: ExcelApi 1.9 ]

thousandsSeparator

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

readonly thousandsSeparator: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.11 ]

useSystemSeparators

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

readonly useSystemSeparators: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.11 ]

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

calculate(calculationType)

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

calculate(calculationType: Excel.CalculationType): void;

Параметры

calculationType
Excel.CalculationType

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

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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

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

calculate(calculationTypeString: "Recalculate" | "Full" | "FullRebuild"): void;

Параметры

calculationTypeString

"Recalculate" | "Full" | "FullRebuild"

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

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => {
    context.workbook.application.calculate('Full');
    await context.sync();
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;

Параметры

options
Excel.Interfaces.ApplicationLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.Application;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Примеры

await Excel.run(async (context) => {
    const application = context.workbook.application;
    application.load('calculationMode');
    await context.sync();

    console.log(application.calculationMode);
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Application;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.ApplicationUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Application): void;

Параметры

properties
Excel.Application

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

void

suspendApiCalculationUntilNextSync()

Приостанавливает вычисление до вызова следующего context.sync() . После этого за пересчет книги и распространение всех зависимостей несет ответственность разработчик.

suspendApiCalculationUntilNextSync(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.6 ]

suspendScreenUpdatingUntilNextSync()

Приостанавливает обновление экрана до вызова следующего context.sync() .

Примечание*. Не вызывайте suspendScreenUpdatingUntilNextSync повторно (например, в цикле). При повторных вызовах окно Excel будет мерцать.

suspendScreenUpdatingUntilNextSync(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

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

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Application является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ApplicationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.ApplicationData;

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