Excel.Workbook class
Workbook 是包含相关工作簿对象（例如工作表、表和区域）的顶级对象。 若要了解有关工作簿对象模型的详细信息，请阅读 使用 Excel JavaScript API 处理工作簿。
- Extends
注解
属性
| application | 表示包含此工作簿的 Excel 应用程序实例。 |
| bindings | 表示属于工作簿的绑定的集合。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| functions | 表示可用于计算的工作表函数的集合。 |
| names | 表示工作簿范围的命名项的集合， () 命名区域和常量。 |
| pivot |
表示一组与 workbook 相关联的 PivotTable 对象。 |
| tables | 表示与工作簿关联的表的集合。 |
| worksheets | 表示与工作簿关联的工作表的集合。 |
方法
| get |
从工作簿中获取当前选定的单个区域。 如果选择了多个范围，此方法将引发错误。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
事件
| on |
文档中的选择更改时发生。 |
属性详细信息
application
表示包含此工作簿的 Excel 应用程序实例。
readonly application: Excel.Application;属性值
注解
bindings
表示属于工作簿的绑定的集合。
readonly bindings: Excel.BindingCollection;属性值
注解
context
functions
表示可用于计算的工作表函数的集合。
readonly functions: Excel.Functions;属性值
注解
names
表示工作簿范围的命名项的集合， () 命名区域和常量。
readonly names: Excel.NamedItemCollection;属性值
注解
pivotTables
表示一组与 workbook 相关联的 PivotTable 对象。
readonly pivotTables: Excel.PivotTableCollection;属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
// Get the names of all the PivotTables in the workbook.
const pivotTables = context.workbook.pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the workbook:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
tables
表示与工作簿关联的表的集合。
readonly tables: Excel.TableCollection;属性值
注解
worksheets
表示与工作簿关联的工作表的集合。
readonly worksheets: Excel.WorksheetCollection;属性值
注解
方法详细信息
getSelectedRange()
从工作簿中获取当前选定的单个区域。 如果选择了多个范围，此方法将引发错误。
getSelectedRange(): Excel.Range;返回
注解
示例
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.Workbook;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Workbook;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.WorkbookUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.Workbook 对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WorkbookData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.WorkbookData;返回
事件详细信息
onSelectionChanged
文档中的选择更改时发生。
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;事件类型
注解
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈