Excel.LinkedWorkbook class

包:

excel

包含有关链接工作簿的信息。 如果工作簿具有指向其他工作簿中数据的链接，则第二个工作簿将链接到第一个工作簿。 在这种情况下，第二个工作簿称为“链接工作簿”。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApiOnline 1.1

使用方

• Excel.LinkedWorkbookCollection： getItem， getItemOrNullObject， items

属性

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