Excel.Application class
Представляет приложение Excel, которое управляет книгой.
- Extends
Комментарии
Свойства
| calculation |
Возвращает режим вычисления, используемый в книге, как определено константами в |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
Методы
| calculate(calculation |
Пересчитывает данные во всех открытых в текущий момент книгах Excel. |
| calculate(calculation |
Пересчитывает данные во всех открытых в текущий момент книгах Excel. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
calculationMode
Возвращает режим вычисления, используемый в книге, как определено константами в Excel.CalculationMode. Возможные значения: Automatic, где Excel управляет пересчетом;AutomaticExceptTables , где Excel управляет пересчетом, но игнорирует изменения в таблицах; Manual, где вычисление выполняется, когда пользователь запрашивает его.
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";Значение свойства
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: 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;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
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
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Application объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ApplicationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.ApplicationData;Возвращаемое значение
Office Add-ins