Excel.Application class
表示用于管理工作簿的 Excel 应用程序。
- 扩展
注解
属性
| calculation |
返回工作簿中使用的计算模式，由 中的 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
方法
| calculate(calculation |
重新计算 Excel 中当前打开的所有工作簿。 |
| calculate(calculation |
重新计算 Excel 中当前打开的所有工作簿。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| suspend |
暂停计算，直到调用下一个 |
| toJSON() | 重写 JavaScript |
属性详细信息
calculationMode
返回工作簿中使用的计算模式，由 中的 Excel.CalculationMode常量定义。 可能的值为：Automatic，其中 Excel 控制重新计算;，AutomaticExceptTables其中 Excel 控制重新计算，但忽略表中的更改;Manual其中，计算在用户请求时完成。
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";属性值
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
注解
context
方法详细信息
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
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
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;