Excel.Application class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

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

context

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

Методы

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

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

calculationMode

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

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

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

context

context: RequestContext;

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

Excel.RequestContext

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

calculate(calculationType)

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

calculate(calculationType: Excel.CalculationType): void;

Параметры

calculationType: Excel.CalculationType

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

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

void

Примеры

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

Примеры

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

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

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

Excel.Application

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.Application

Примеры

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

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

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.Application

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

toJSON()

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

toJSON(): Excel.Interfaces.ApplicationData;

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

Excel.Interfaces.ApplicationData

Excel.Application class

Комментарии

Свойства

Методы

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

calculationMode

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

Комментарии

context

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

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

calculate(calculationType)

Параметры

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

Комментарии

Примеры

calculate(calculationTypeString)

Параметры

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

suspendApiCalculationUntilNextSync()

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

Комментарии

toJSON()

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

Обратная связь

Дополнительные ресурсы