This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
Represents a collection ofLinkedEntityDataDomain objects. The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
| add(options) | Adds a linked entity data domain object defined by the Office Add-in to the collection. Once the linked entity data domain is added, it can be used to create |
| get | Gets the number of linked entity data domains in the collection. |
| get | Gets a linked entity data domain by its |
| get | Gets a linked entity data domain by its index in the collection. |
| get | Gets a linked entity data domain by its |
| get | Gets a linked entity data domain by its |
| get | Gets a linked entity data domain by its |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property | Queues up a command to load the specified properties of the object. You must call |
| load(property | Queues up a command to load the specified properties of the object. You must call |
| refresh | Refreshes all |
| toJSON() | Overrides the JavaScript |
| on | Occurs when a new linked entity data domain is added to the workbook. |
| on | Occurs when the request to refresh |
| on | Occurs when the |
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Gets the loaded child items in this collection.
readonly items: Excel.LinkedEntityDataDomain[];Adds a linked entity data domain object defined by the Office Add-in to the collection. Once the linked entity data domain is added, it can be used to createLinkedEntityCellValue objects.
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;Options that are used to create the linked entity data domain to be added.
void
Gets the number of linked entity data domains in the collection.
getCount(): OfficeExtension.ClientResult<number>;OfficeExtension.ClientResult<number>
Gets a linked entity data domain by itsid.
getItem(id: string): Excel.LinkedEntityDataDomain;string
Theid of theLinkedEntityDataDomain object to be retrieved.
The linked entity data domain with the givenid. If there are multiple linked entity data domains with the sameid, the one defined by this Office Add-in will be returned.
Gets a linked entity data domain by its index in the collection.
getItemAt(index: number): Excel.LinkedEntityDataDomain;number
The index of the linked entity data domain in the collection.
The linked entity data domain at the given index.
Gets a linked entity data domain by itsname.
getItemByName(name: string): Excel.LinkedEntityDataDomain;string
Thename of theLinkedEntityDataDomain object to be retrieved.
The linked entity data domain with the givenname. If there are multiple linked entity data domains with the samename, the one defined by this Office Add-in will be returned.
Gets a linked entity data domain by itsname. If the linked entity data domain does not exist, then this method returns an object with itsisNullObject property set totrue. For further information, see*OrNullObject methods and properties.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;string
Thename of theLinkedEntityDataDomain object to be retrieved.
The linked entity data domain with the givenname. If there are multiple linked entity data domains with the samename, the one defined by this Office Add-in will be returned.
Gets a linked entity data domain by itsid. If the linked entity data domain does not exist, then this method returns an object with itsisNullObject property set totrue. For further information, see*OrNullObject methods and properties.
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;string
Theid of theLinkedEntityDataDomain object to be retrieved.
The linked entity data domain with the givenid. If there are multiple linked entity data domains with the sameid, the one defined by this Office Add-in will be returned.
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions &Excel.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, andpropertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Refreshes allLinkedEntityCellValue objects of all linked entity data domains in this collection. The refresh request can fail if the data providers are busy or temporarily inaccessible.
refreshAll(): void;void
Overrides the JavaScripttoJSON() method in order to provide more useful output when an API object is passed toJSON.stringify(). (JSON.stringify, in turn, calls thetoJSON method of the object that's passed to it.) Whereas the originalExcel.LinkedEntityDataDomainCollection object is an API object, thetoJSON method returns a plain JavaScript object (typed asExcel.Interfaces.LinkedEntityDataDomainCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;Occurs when a new linked entity data domain is added to the workbook.
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;Occurs when the request to refreshLinkedEntityCellValue objects of a linked entity data domain is completed.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Occurs when therefreshMode of a linked entity data domain is changed.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;Was this page helpful?
Was this page helpful?