Excel.LinkedWorkbookCollection class
表示链接的工作簿对象的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
| workbook |
表示工作簿链接的更新模式。 该模式对于工作簿中存在的所有工作簿链接都是相同的。 |
方法
| break |
断开指向链接工作簿的所有链接。 链接断开后，将完全删除引用工作簿链接的所有公式，并将其替换为最近检索的值。 |
| get |
按 URL 获取有关链接工作簿的信息。 |
| get |
按 URL 获取有关链接工作簿的信息。 如果工作簿不存在，则此方法返回一个 对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| refresh |
发出刷新所有工作簿链接的请求。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
workbookLinksRefreshMode
表示工作簿链接的更新模式。 该模式对于工作簿中存在的所有工作簿链接都是相同的。
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";属性值
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
注解
方法详细信息
breakAllLinks()
断开指向链接工作簿的所有链接。 链接断开后，将完全删除引用工作簿链接的所有公式，并将其替换为最近检索的值。
breakAllLinks(): void;返回
void
注解
getItem(key)
按 URL 获取有关链接工作簿的信息。
getItem(key: string): Excel.LinkedWorkbook;参数
- key
-
string
链接工作簿的 URL。
返回
具有给定 URL 的链接工作簿。
注解
getItemOrNullObject(key)
按 URL 获取有关链接工作簿的信息。 如果工作簿不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.LinkedWorkbook;参数
- key
-
string
链接工作簿的 URL。
返回
具有给定 URL 的链接工作簿。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;参数
- options
-
Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.LinkedWorkbookCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedWorkbookCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
refreshAll()
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.LinkedWorkbookCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedWorkbookCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;