Excel.LinkedEntityDataDomainCreateOptions interface

Paket:
excel

Stellt Optionen dar, die verwendet werden, um das Objekt zu erstellen, das LinkedEntityDataDomain dem LinkedEntityDataDomainCollectionhinzugefügt wird.

Hinweise

API-Satz: ExcelApi 1.19

Diese Schnittstelle wird in Excel im Web nicht unterstützt.

Verwendet von

Beispiele

// Registers linked entity data domains when the add-in loads.
await Excel.run(async (context) => {
    const productsDomainOptions: Excel.LinkedEntityDataDomainCreateOptions = {
        dataProvider: "Contoso",
        id: "products",
        name: "Products",
        // ID of the custom function called by Excel to resolve or refresh linked entity cell values.
        loadFunctionId: "CONTOSOLOADSERVICE",
        // periodicRefreshInterval is only required when supportedRefreshModes contains "Periodic".
        periodicRefreshInterval: 300,
        // Manual refresh mode is always supported, even if unspecified.
        supportedRefreshModes: [
            Excel.LinkedEntityDataDomainRefreshMode.periodic,
            Excel.LinkedEntityDataDomainRefreshMode.onLoad
        ]
    };

    // Add the data domain to the collection to register it.
    context.workbook.linkedEntityDataDomains.add(productsDomainOptions);
    await context.sync();
});

Eigenschaften

dataProvider

Gibt den Namen des Datenanbieters für die verknüpfte Entitätsdatendomäne 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 verknüpften Entitätsdatendomäne an. Dieser Name muss in allen von diesem Office-Add-In definierten verknüpften Entitätsdatendomänen eindeutig sein.
periodicRefreshInterval

Gibt die Häufigkeit in Sekunden an, mit der LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne automatisch aktualisiert werden. Der gültige Mindestwert 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" eingestellt ist.
supportedRefreshModes

Gibt alle Aktualisierungsmodi an, die von der Datendomäne der verknüpften Entität unterstützt werden. Der Standardwert ist ["Manual"], der immer unterstützt wird, auch wenn er nicht angegeben ist. Der in der Arbeitsmappe gespeicherte Aktualisierungsmodus wird beim nächsten Öffnen der Arbeitsmappe als Standardaktualisierungsmodus der verknüpften Entitätsdatendomäne geladen. Wenn der Aktualisierungsmodus nicht in der Arbeitsmappe gespeichert wurde, wird der erste Wert im Array als Standardaktualisierungsmodus der verknüpften Entitätsdatendomäne festgelegt. Wenn das Array den Wert "Periodic" hat, 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 verknüpfte Entitätsdatendomäne an.

dataProvider: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

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

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

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

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

name

Gibt den Namen der verknüpften Entitätsdatendomäne an. Dieser Name muss in allen von diesem Office-Add-In definierten verknüpften Entitätsdatendomänen eindeutig sein.

name: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

periodicRefreshInterval

Gibt die Häufigkeit in Sekunden an, mit der LinkedEntityCellValue Objekte dieser verknüpften Entitätsdatendomäne automatisch aktualisiert werden. Der gültige Mindestwert 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" eingestellt ist.

periodicRefreshInterval?: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.19

Diese Eigenschaft wird in Excel im Web nicht unterstützt.

supportedRefreshModes

Gibt alle Aktualisierungsmodi an, die von der Datendomäne der verknüpften Entität unterstützt werden. Der Standardwert ist ["Manual"], der immer unterstützt wird, auch wenn er nicht angegeben ist. Der in der Arbeitsmappe gespeicherte Aktualisierungsmodus wird beim nächsten Öffnen der Arbeitsmappe als Standardaktualisierungsmodus der verknüpften Entitätsdatendomäne geladen. Wenn der Aktualisierungsmodus nicht in der Arbeitsmappe gespeichert wurde, wird der erste Wert im Array als Standardaktualisierungsmodus der verknüpften Entitätsdatendomäne festgelegt. Wenn das Array den Wert "Periodic" hat, 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

Diese Eigenschaft wird in Excel im Web nicht unterstützt.