Excel.LinkedEntityDataDomainCreateOptions interface

Paket:

excel

Stellt Optionen dar, die zum Erstellen des LinkedEntityDataDomain -Objekts verwendet werden, das dem LinkedEntityDataDomainCollectionhinzugefügt wird.

Hinweise

[ API-Satz: ExcelApi 1.19 ]

Eigenschaften

dataProvider	Gibt den Namen des Datenanbieters für die Datendomäne der verknüpften Entität an.
id	Gibt die ID der Datendomäne der verknüpften Entität an. Diese ID muss für alle verknüpften Entitätsdatendomänen eindeutig sein, die von diesem Office-Add-In definiert werden.
loadFunctionId	Gibt die ID der benutzerdefinierten Funktion an, die bei Bedarf aufgerufen wird, um die LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne aufzulösen oder zu aktualisieren. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID.
name	Gibt den Namen der Datendomäne der verknüpften Entität an. Dieser Name muss für alle verknüpften Entitätsdatendomänen eindeutig sein, die von diesem Office-Add-In definiert werden.
periodicRefreshInterval	Gibt die Häufigkeit in Sekunden an, mit LinkedEntityCellValue der Objekte dieser verknüpften Entitäts-Datendomäne automatisch aktualisiert werden. Der minimale gültige Wert ist 300. Diese Eigenschaft ist erforderlich, wenn das supportedRefreshModes Array den Wert "Periodic" enthält. Diese Eigenschaft gilt nur, wenn die refreshMode der Datendomäne der verknüpften Entität auf "Periodisch" festgelegt ist.
supportedRefreshModes	Gibt alle Aktualisierungsmodi an, die von der Datendomäne der verknüpften Entität unterstützt werden. Der Standardwert ist ["Manual"], was auch ohne Angabe immer unterstützt wird. Der in der Arbeitsmappe gespeicherte Aktualisierungsmodus wird als Standardaktualisierungsmodus der Datendomäne der verknüpften Entität bei der nächsten geöffneten Arbeitsmappe geladen. Wenn der Aktualisierungsmodus nicht in der Arbeitsmappe gespeichert wurde, wird der erste Wert im Array als Standardaktualisierungsmodus der Datendomäne der verknüpften Entität festgelegt. Wenn das Array den Wert "Periodisch" aufweist, muss die periodicRefreshInterval Eigenschaft auch für die Datendomäne der verknüpften Entität festgelegt werden.

Details zur Eigenschaft

dataProvider

Gibt den Namen des Datenanbieters für die Datendomäne der verknüpften Entität an.

dataProvider: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

id

Gibt die ID der Datendomäne der verknüpften Entität an. Diese ID muss für alle verknüpften Entitätsdatendomänen eindeutig sein, die von diesem Office-Add-In definiert werden.

id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

loadFunctionId

Gibt die ID der benutzerdefinierten Funktion an, die bei Bedarf aufgerufen wird, um die LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne aufzulösen oder zu aktualisieren. Weitere Informationen finden Sie unter Automatisches Generieren von JSON-Metadaten für benutzerdefinierte Funktionen: ID.

loadFunctionId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

name

Gibt den Namen der Datendomäne der verknüpften Entität an. Dieser Name muss für alle verknüpften Entitätsdatendomänen eindeutig sein, die von diesem Office-Add-In definiert werden.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.19 ]

periodicRefreshInterval

Gibt die Häufigkeit in Sekunden an, mit LinkedEntityCellValue der Objekte dieser verknüpften Entitäts-Datendomäne automatisch aktualisiert werden. Der minimale gültige Wert ist 300. Diese Eigenschaft ist erforderlich, wenn das supportedRefreshModes Array den Wert "Periodic" enthält. Diese Eigenschaft gilt nur, wenn die refreshMode der Datendomäne der verknüpften Entität auf "Periodisch" festgelegt ist.

periodicRefreshInterval?: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.19 ]

supportedRefreshModes

Gibt alle Aktualisierungsmodi an, die von der Datendomäne der verknüpften Entität unterstützt werden. Der Standardwert ist ["Manual"], was auch ohne Angabe immer unterstützt wird. Der in der Arbeitsmappe gespeicherte Aktualisierungsmodus wird als Standardaktualisierungsmodus der Datendomäne der verknüpften Entität bei der nächsten geöffneten Arbeitsmappe geladen. Wenn der Aktualisierungsmodus nicht in der Arbeitsmappe gespeichert wurde, wird der erste Wert im Array als Standardaktualisierungsmodus der Datendomäne der verknüpften Entität festgelegt. Wenn das Array den Wert "Periodisch" aufweist, muss die periodicRefreshInterval Eigenschaft auch für die Datendomäne der verknüpften Entität festgelegt werden.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Eigenschaftswert

Excel.LinkedEntityDataDomainRefreshMode[]

Hinweise

[ API-Satz: ExcelApi 1.19 ]