Excel.LinkedEntityDataDomainCollection class
Stellt eine Sammlung von LinkedEntityDataDomain Objekten dar. Die Sammlung kann verknüpfte Entitätsdatendomänen wie Aktien, Geografie oder Währungen enthalten, die von Dienstdatenanbietern wie Bing oder Power BI definiert werden, oder verknüpfte Entitätsdatendomänen, die von Office-Add-Ins definiert werden.
- Extends
Hinweise
[API-Satz: ExcelApi 1.19]
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(options) | Fügt der Sammlung ein vom Office-Add-In definiertes verknüpftes Objekt der Entitätsdaten hinzu. Nachdem die verknüpfte Entitätsdatendomäne hinzugefügt wurde, kann sie zum Erstellen von |
| get |
Ruft die Anzahl der verknüpften Entitätsdatendomänen in der Auflistung ab. |
| get |
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer |
| get |
Ruft eine verknüpfte Entitätsdatendomäne anhand ihres Index in der Auflistung ab. |
| get |
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer |
| get |
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer |
| get |
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load |
Sendet eine Anforderung zum Laden des |
| refresh |
Aktualisiert alle |
| toJSON() | Überschreibt die JavaScript-Methode |
Ereignisse
| on |
Tritt auf, wenn die Anforderung zum Laden eines |
| on |
Tritt auf, wenn eine neue verknüpfte Entitätsdatendomäne zur Arbeitsmappe hinzugefügt wird. |
| on |
Tritt auf, wenn die Anforderung zum Aktualisieren |
| on |
Tritt auf, wenn die |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.LinkedEntityDataDomain[];Eigenschaftswert
Details zur Methode
add(options)
Fügt der Sammlung ein vom Office-Add-In definiertes verknüpftes Objekt der Entitätsdaten hinzu. Nachdem die verknüpfte Entitätsdatendomäne hinzugefügt wurde, kann sie zum Erstellen von LinkedEntityCellValue Objekten verwendet werden.
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;Parameter
Optionen, die verwendet werden, um die verknüpfte Entitätsdatendomäne zu erstellen, die hinzugefügt werden soll.
Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.19]
getCount()
Ruft die Anzahl der verknüpften Entitätsdatendomänen in der Auflistung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
[API-Satz: ExcelApi 1.19]
getItem(id)
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer id.
getItem(id: string): Excel.LinkedEntityDataDomain;Parameter
- id
-
string
Die des id abzurufenden Objekts LinkedEntityDataDomain .
Gibt zurück
Die verknüpfte Entitätsdatendomäne mit der angegebenen id. Wenn mehrere verknüpfte Entitätsdatendomänen mit demselben idvorhanden sind, wird die von diesem Office-Add-In definierte zurückgegeben.
Hinweise
[API-Satz: ExcelApi 1.19]
getItemAt(index)
Ruft eine verknüpfte Entitätsdatendomäne anhand ihres Index in der Auflistung ab.
getItemAt(index: number): Excel.LinkedEntityDataDomain;Parameter
- index
-
number
Der Index der verknüpften Entitätsdatendomäne in der Sammlung.
Gibt zurück
Die Datendomäne der verknüpften Entität am angegebenen Index.
Hinweise
[API-Satz: ExcelApi 1.19]
getItemByName(name)
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer name.
getItemByName(name: string): Excel.LinkedEntityDataDomain;Parameter
- name
-
string
Die des name abzurufenden Objekts LinkedEntityDataDomain .
Gibt zurück
Die verknüpfte Entitätsdatendomäne mit der angegebenen name. Wenn mehrere verknüpfte Entitätsdatendomänen mit demselben namevorhanden sind, wird die von diesem Office-Add-In definierte zurückgegeben.
Hinweise
[API-Satz: ExcelApi 1.19]
getItemByNameOrNullObject(name)
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer name. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;Parameter
- name
-
string
Die des name abzurufenden Objekts LinkedEntityDataDomain .
Gibt zurück
Die verknüpfte Entitätsdatendomäne mit der angegebenen name. Wenn mehrere verknüpfte Entitätsdatendomänen mit demselben namevorhanden sind, wird die von diesem Office-Add-In definierte zurückgegeben.
Hinweise
[API-Satz: ExcelApi 1.19]
getItemOrNullObject(id)
Ruft eine verknüpfte Entitätsdatendomäne anhand ihrer id. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;Parameter
- id
-
string
Die des id abzurufenden Objekts LinkedEntityDataDomain .
Gibt zurück
Die verknüpfte Entitätsdatendomäne mit der angegebenen id. Wenn mehrere verknüpfte Entitätsdatendomänen mit demselben idvorhanden sind, wird die von diesem Office-Add-In definierte zurückgegeben.
Hinweise
[API-Satz: ExcelApi 1.19]
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;Parameter
- options
-
Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
loadLinkedEntityCellValue(id)
Sendet eine Anforderung zum Laden des LinkedEntityCellValue Objekts mit dem angegebenen LinkedEntityId. Wenn das Objekt gefunden wird, wird es LinkedEntityCellValue über das LinkedEntityCellValueLoaded Ereignis zurückgegeben.
loadLinkedEntityCellValue(id: LinkedEntityId): void;Parameter
Ein bestimmtes LinkedEntityId
Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.21]
refreshAll()
Aktualisiert alle LinkedEntityCellValue Objekte aller verknüpften Entitätsdatendomänen in dieser Sammlung. Die Aktualisierungsanforderung kann fehlschlagen, wenn die Datenanbieter ausgelastet oder vorübergehend nicht erreichbar sind.
refreshAll(): void;Gibt zurück
void
Hinweise
[API-Satz: ExcelApi 1.19]
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.LinkedEntityDataDomainCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedEntityDataDomainCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;Gibt zurück
Details zum Ereignis
onLinkedEntityCellValueLoaded
Tritt auf, wenn die Anforderung zum Laden eines LinkedEntityCellValue
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;Ereignistyp
Hinweise
[API-Satz: ExcelApi 1.21]
Dieses Ereignis wird in Excel im Web nicht unterstützt.
onLinkedEntityDataDomainAdded
Tritt auf, wenn eine neue verknüpfte Entitätsdatendomäne zur Arbeitsmappe hinzugefügt wird.
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;Ereignistyp
Hinweise
[API-Satz: ExcelApi 1.19]
onRefreshCompleted
Tritt auf, wenn die Anforderung zum Aktualisieren LinkedEntityCellValue von Objekten einer verknüpften Entitätsdatendomäne abgeschlossen ist.
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;Ereignistyp
Hinweise
[API-Satz: ExcelApi 1.19]
onRefreshModeChanged
Tritt auf, wenn die refreshMode Datendomäne einer verknüpften Entität geändert wird.
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;Ereignistyp
Hinweise
[API-Satz: ExcelApi 1.19]