Excel.LinkedEntityDataDomainCreateOptions interface

注釈

API セット: ExcelApi 1.19

このインターフェイスは、Excel on the web ではサポートされていません。

使用元

• Excel.LinkedEntityDataDomainCollection: add

例

// 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();
});

プロパティ

dataProvider

dataProvider: string;

id

id: string;

loadFunctionId

loadFunctionId: string;

name

name: string;

periodicRefreshInterval

periodicRefreshInterval?: number;

supportedRefreshModes

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];