Excel.LinkedWorkbook class

包:

excel

包含有关链接工作簿的信息。 如果工作簿具有指向另一个工作簿中的数据的链接，则第二个工作簿将链接到第一个工作簿。 在此方案中，第二个工作簿称为“链接工作簿”。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApiOnline 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	指向链接工作簿的原始 URL。 它在集合中的所有链接工作簿中都是唯一的。

方法

breakLinks()	发出断开指向链接工作簿的链接的请求。 公式中的链接将替换为最新提取的数据。 当前 LinkedWorkbook 对象无效并从 中删除 LinkedWorkbookCollection。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
refresh()	发出刷新从链接工作簿检索到的数据的请求。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.LinkedWorkbook对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedWorkbookData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

id

指向链接工作簿的原始 URL。 它在集合中的所有链接工作簿中都是唯一的。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApiOnline 1.1 ]

方法详细信息

breakLinks()

发出断开指向链接工作簿的链接的请求。 公式中的链接将替换为最新提取的数据。 当前 LinkedWorkbook 对象无效并从 中删除 LinkedWorkbookCollection。

breakLinks(): void;

返回

void

注解

[ API 集：ExcelApiOnline 1.1 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.LinkedWorkbookLoadOptions): Excel.LinkedWorkbook;

参数

options

Excel.Interfaces.LinkedWorkbookLoadOptions

提供要加载对象的属性的选项。

返回

Excel.LinkedWorkbook

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.LinkedWorkbook

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.LinkedWorkbook

refresh()

发出刷新从链接工作簿检索到的数据的请求。

refresh(): void;

返回

void

注解

[ API 集：ExcelApiOnline 1.1 ]

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.LinkedWorkbook对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedWorkbookData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.LinkedWorkbookData;

返回

Excel.Interfaces.LinkedWorkbookData