Excel.LinkedDataType class

包:

excel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示链接数据类型。 链接数据类型是连接到联机数据源的数据类型。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi BETA (仅预览版) ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
dataProvider	链接数据类型的数据提供程序的名称。 从服务检索信息时，这可能会更改。
lastRefreshed	自上次刷新链接数据类型时打开工作簿以来的本地时区日期和时间。 undefined如果链接数据类型尚未刷新，则返回 。
name	链接数据类型的名称。 从服务检索信息时，这可能会更改。
periodicRefreshInterval	如果 refreshMode 设置为“定期”，则刷新链接数据类型的频率（以秒为单位）。
refreshMode	检索链接数据类型数据的机制。
serviceId	链接数据类型的唯一 ID。
supportedRefreshModes	返回一个数组，其中包含链接数据类型支持的所有刷新模式。 从服务检索信息时，数组的内容可能会更改。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
requestRefresh()	发出刷新链接数据类型的请求。 如果服务繁忙或暂时无法访问，则不会满足请求。
requestSetRefreshMode(refreshMode)	发出更改此链接数据类型的刷新模式的请求。 如果此链接数据类型不支持给定的刷新模式，则模式保持不变。 如果设置为“定期”，则刷新间隔将设置为基于特定链接数据类型的预定义值。
requestSetRefreshMode(refreshModeString)	发出更改此链接数据类型的刷新模式的请求。 如果此链接数据类型不支持给定的刷新模式，则模式保持不变。 如果设置为“定期”，则刷新间隔将设置为基于特定链接数据类型的预定义值。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始 Excel.LinkedDataType 对象是 API 对象，但toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedDataTypeData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

context: RequestContext;

属性值

Excel.RequestContext

dataProvider

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

链接数据类型的数据提供程序的名称。 从服务检索信息时，这可能会更改。

readonly dataProvider: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

lastRefreshed

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

自上次刷新链接数据类型时打开工作簿以来的本地时区日期和时间。 undefined如果链接数据类型尚未刷新，则返回 。

readonly lastRefreshed: Date;

属性值

Date

注解

[ API 集：ExcelApi BETA (仅预览版) ]

name

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

链接数据类型的名称。 从服务检索信息时，这可能会更改。

readonly name: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

periodicRefreshInterval

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

如果 refreshMode 设置为“定期”，则刷新链接数据类型的频率（以秒为单位）。

readonly periodicRefreshInterval: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

refreshMode

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

检索链接数据类型数据的机制。

readonly refreshMode: Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

属性值

Excel.LinkedDataTypeRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

注解

[ API 集：ExcelApi BETA (仅预览版) ]

serviceId

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

链接数据类型的唯一 ID。

readonly serviceId: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

supportedRefreshModes

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回一个数组，其中包含链接数据类型支持的所有刷新模式。 从服务检索信息时，数组的内容可能会更改。

readonly supportedRefreshModes: Excel.LinkedDataTypeRefreshMode[];

属性值

Excel.LinkedDataTypeRefreshMode[]

注解

[ API 集：ExcelApi BETA (仅预览版) ]

方法详细信息

load(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

load(options?: Excel.Interfaces.LinkedDataTypeLoadOptions): Excel.LinkedDataType;

参数

options

Excel.Interfaces.LinkedDataTypeLoadOptions

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

返回

Excel.LinkedDataType

load(propertyNames)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

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

参数

propertyNames

string | string[]

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

返回

Excel.LinkedDataType

load(propertyNamesAndPaths)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.LinkedDataType

requestRefresh()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

发出刷新链接数据类型的请求。 如果服务繁忙或暂时无法访问，则不会满足请求。

requestRefresh(): void;

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

requestSetRefreshMode(refreshMode)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

发出更改此链接数据类型的刷新模式的请求。 如果此链接数据类型不支持给定的刷新模式，则模式保持不变。 如果设置为“定期”，则刷新间隔将设置为基于特定链接数据类型的预定义值。

requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode): void;

参数

refreshMode

Excel.LinkedDataTypeRefreshMode

请求更改此链接数据类型的预期模式。

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

requestSetRefreshMode(refreshModeString)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

发出更改此链接数据类型的刷新模式的请求。 如果此链接数据类型不支持给定的刷新模式，则模式保持不变。 如果设置为“定期”，则刷新间隔将设置为基于特定链接数据类型的预定义值。

requestSetRefreshMode(refreshModeString: "Unknown" | "Manual" | "OnLoad" | "Periodic"): void;

参数

refreshModeString

"Unknown" | "Manual" | "OnLoad" | "Periodic"

请求更改此链接数据类型的预期模式。

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

toJSON()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

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

toJSON(): Excel.Interfaces.LinkedDataTypeData;

返回

Excel.Interfaces.LinkedDataTypeData