Excel.LinkedEntityDataDomainCollection class

Paket:

excel

Stellt eine Auflistung von LinkedEntityDataDomain -Objekten dar. Die Sammlung kann verknüpfte Entitätsdatendomänen wie Aktien, Geografie oder Währungen enthalten, die von Dienstanbietern wie Bing oder Power BI definiert werden, oder Datendomänen verknüpfter Entitäten, die von Office-Add-Ins definiert werden.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.19 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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 Auflistung ein vom Office-Add-In definiertes Datendomänenobjekt für verknüpfte Entitäten hinzu. Nachdem die Datendomäne der verknüpften Entität hinzugefügt wurde, kann sie zum Erstellen von LinkedEntityCellValue Objekten verwendet werden.
getCount()	Ruft die Anzahl der Verknüpften Entitätsdatendomänen in der Auflistung ab.
getItem(id)	Ruft eine verknüpfte Entitäts-Datendomäne nach deren idab.
getItemAt(index)	Ruft eine verknüpfte Entitätsdatendomäne nach ihrem Index in der Auflistung ab.
getItemByName(name)	Ruft eine verknüpfte Entitäts-Datendomäne nach deren nameab.
getItemByNameOrNullObject(name)	Ruft eine verknüpfte Entitäts-Datendomäne nach deren nameab. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Funktion ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(id)	Ruft eine verknüpfte Entitäts-Datendomäne nach deren idab. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Funktion ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
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(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(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.
refreshAll()	Aktualisiert alle LinkedEntityCellValue Objekte aller verknüpften Entitätsdatendomänen in dieser Auflistung. Die Aktualisierungsanforderung kann fehlschlagen, wenn die Datenanbieter ausgelastet sind oder vorübergehend nicht zugegriffen werden kann.
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 das Objekt ü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 Auflistung enthält.

Ereignisse

onLinkedEntityDataDomainAdded	Tritt auf, wenn der Arbeitsmappe eine neue Datendomäne für verknüpfte Entitäten hinzugefügt wird.
onRefreshCompleted	Tritt auf, wenn die Anforderung zum Aktualisieren LinkedEntityCellValue von Objekten einer verknüpften Entitäts-Datendomäne abgeschlossen ist.
onRefreshModeChanged	Tritt auf, wenn die refreshMode einer verknüpften Entitäts-Datendomäne geändert wird.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.LinkedEntityDataDomain[];

Eigenschaftswert

Excel.LinkedEntityDataDomain[]

Details zur Methode

add(options)

Fügt der Auflistung ein vom Office-Add-In definiertes Datendomänenobjekt für verknüpfte Entitäten hinzu. Nachdem die Datendomäne der verknüpften Entität hinzugefügt wurde, kann sie zum Erstellen von LinkedEntityCellValue Objekten verwendet werden.

add(options: Excel.LinkedEntityDataDomainCreateOptions): void;

Parameter

options

Excel.LinkedEntityDataDomainCreateOptions

Optionen, die zum Erstellen der hinzuzufügenden Datendomäne für verknüpfte Entitäten verwendet werden.

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äts-Datendomäne nach deren idab.

getItem(id: string): Excel.LinkedEntityDataDomain;

Parameter

id

string

Der id des LinkedEntityDataDomain abzurufenden Objekts.

Gibt zurück

Excel.LinkedEntityDataDomain

Die Datendomäne der verknüpften Entität mit dem 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 nach ihrem Index in der Auflistung ab.

getItemAt(index: number): Excel.LinkedEntityDataDomain;

Parameter

index

number

Der Index der Datendomäne der verknüpften Entität in der Sammlung.

Gibt zurück

Excel.LinkedEntityDataDomain

Die Datendomäne der verknüpften Entität am angegebenen Index.

Hinweise

[ API-Satz: ExcelApi 1.19 ]

getItemByName(name)

Ruft eine verknüpfte Entitäts-Datendomäne nach deren nameab.

getItemByName(name: string): Excel.LinkedEntityDataDomain;

Parameter

name

string

Der name des LinkedEntityDataDomain abzurufenden Objekts.

Gibt zurück

Excel.LinkedEntityDataDomain

Die Datendomäne der verknüpften Entität mit dem 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äts-Datendomäne nach deren nameab. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Funktion ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;

Parameter

name

string

Der name des LinkedEntityDataDomain abzurufenden Objekts.

Gibt zurück

Excel.LinkedEntityDataDomain

Die Datendomäne der verknüpften Entität mit dem 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äts-Datendomäne nach deren idab. Wenn die Datendomäne der verknüpften Entität nicht vorhanden ist, gibt diese Funktion ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;

Parameter

id

string

Der id des LinkedEntityDataDomain abzurufenden Objekts.

Gibt zurück

Excel.LinkedEntityDataDomain

Die Datendomäne der verknüpften Entität mit dem 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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.LinkedEntityDataDomainCollection

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

Excel.LinkedEntityDataDomainCollection

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 Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.LinkedEntityDataDomainCollection

refreshAll()

Aktualisiert alle LinkedEntityCellValue Objekte aller verknüpften Entitätsdatendomänen in dieser Auflistung. Die Aktualisierungsanforderung kann fehlschlagen, wenn die Datenanbieter ausgelastet sind oder vorübergehend nicht zugegriffen werden kann.

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 das Objekt ü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 Auflistung enthält.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;

Gibt zurück

Excel.Interfaces.LinkedEntityDataDomainCollectionData

Details zum Ereignis

onLinkedEntityDataDomainAdded

Tritt auf, wenn der Arbeitsmappe eine neue Datendomäne für verknüpfte Entitäten hinzugefügt wird.

readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.19 ]

onRefreshCompleted

Tritt auf, wenn die Anforderung zum Aktualisieren LinkedEntityCellValue von Objekten einer verknüpften Entitäts-Datendomäne abgeschlossen ist.

readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.19 ]

onRefreshModeChanged

Tritt auf, wenn die refreshMode einer verknüpften Entitäts-Datendomäne geändert wird.

readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.19 ]