Excel.LinkedEntityDataDomainCollection class
表示 对象的集合 LinkedEntityDataDomain 。 集合可以包含链接实体数据域，例如股票、地理位置或由服务数据提供程序（如必应或 Power BI）定义的货币，或 Office 外接程序定义的链接实体数据域。
注解
方法
| add(options) | 将 Office 外接程序定义的链接实体数据域对象添加到集合。 添加链接实体数据域后，可用于创建 |
| get |
获取集合中链接实体数据域的数目。 |
| get |
通过其 |
| get |
按集合中的索引获取链接实体数据域。 |
| get |
通过其 |
| get |
通过其 |
| get |
通过其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| refresh |
刷新此集合中所有链接实体数据域的所有 |
| toJSON() | 重写 JavaScript |
事件
| on |
在将新的链接实体数据域添加到工作簿时发生。 |
| on |
在完成对链接实体数据域的对象刷新 |
| on |
在链接实体数据域的 更改时 |
属性详细信息
context
items
方法详细信息
add(options)
将 Office 外接程序定义的链接实体数据域对象添加到集合。 添加链接实体数据域后，可用于创建 LinkedEntityCellValue 对象。
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;参数
用于创建要添加的链接实体数据域的选项。
返回
void
注解
getCount()
获取集合中链接实体数据域的数目。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(id)
通过其 id获取链接实体数据域。
getItem(id: string): Excel.LinkedEntityDataDomain;参数
- id
-
string
id要检索的 LinkedEntityDataDomain 对象的 。
返回
具有给定 id的链接实体数据域。 如果有多个链接实体数据域具有相同 id，则将返回此 Office 外接程序定义的域。
注解
getItemAt(index)
按集合中的索引获取链接实体数据域。
getItemAt(index: number): Excel.LinkedEntityDataDomain;参数
- index
-
number
集合中链接实体数据域的索引。
返回
给定索引处的链接实体数据域。
注解
getItemByName(name)
通过其 name获取链接实体数据域。
getItemByName(name: string): Excel.LinkedEntityDataDomain;参数
- name
-
string
name要检索的 LinkedEntityDataDomain 对象的 。
返回
具有给定 name的链接实体数据域。 如果有多个链接实体数据域具有相同 name，则将返回此 Office 外接程序定义的域。
注解
getItemByNameOrNullObject(name)
通过其 name获取链接实体数据域。 如果链接的实体数据域不存在，则此函数将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;参数
- name
-
string
name要检索的 LinkedEntityDataDomain 对象的 。
返回
具有给定 name的链接实体数据域。 如果有多个链接实体数据域具有相同 name，则将返回此 Office 外接程序定义的域。
注解
getItemOrNullObject(id)
通过其 id获取链接实体数据域。 如果链接的实体数据域不存在，则此函数将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;参数
- id
-
string
id要检索的 LinkedEntityDataDomain 对象的 。
返回
具有给定 id的链接实体数据域。 如果有多个链接实体数据域具有相同 id，则将返回此 Office 外接程序定义的域。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;参数
- options
-
Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
refreshAll()
刷新此集合中所有链接实体数据域的所有 LinkedEntityCellValue 对象。 如果数据提供程序繁忙或暂时无法访问，刷新请求可能会失败。
refreshAll(): void;返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.LinkedEntityDataDomainCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LinkedEntityDataDomainCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;返回
事件详细信息
onLinkedEntityDataDomainAdded
在将新的链接实体数据域添加到工作簿时发生。
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;事件类型
注解
onRefreshCompleted
在完成对链接实体数据域的对象刷新 LinkedEntityCellValue 请求时发生。
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;事件类型
注解
onRefreshModeChanged
在链接实体数据域的 更改时 refreshMode 发生。
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;