Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs interface

Package:

excel

Provides information about the linked entity data domain whose refresh mode was changed.

Remarks

API set: ExcelApi 1.19

This interface isn't supported in Excel on the web.

Used by

• Excel.LinkedEntityDataDomainCollection: onRefreshModeChanged

Examples

// Registers an event handler for the onRefreshModeChanged event.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
    dataDomains.onRefreshModeChanged.add(onRefreshModeChanged);

    await context.sync();
});

async function onRefreshModeChanged(eventArgs: Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs): Promise<void> {
    console.log(`Linked entity domain refresh mode changed: ${eventArgs.id}`);
    console.log(`Event type: ${eventArgs.type}`);
    console.log(`Event source: ${eventArgs.source}`);
    console.log(`Service ID: ${eventArgs.serviceId}`);
    console.log(`New refresh mode: ${eventArgs.refreshMode}`);
}

Properties

id	Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
refreshMode	Gets the new refresh mode of the linked entity data domain.
serviceId	Gets the service ID of the linked entity data domain whose refresh mode was changed.
source	Gets the source of the event. See Excel.EventSource for details.
type	Gets the type of the event. See Excel.EventType for details.

Property Details

id

Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins. This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.

id?: string;

Property Value

string

Remarks

API set: ExcelApi 1.19

This property isn't supported in Excel on the web.

refreshMode

Gets the new refresh mode of the linked entity data domain.

refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";

Property Value

Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"

Remarks

API set: ExcelApi 1.19

This property isn't supported in Excel on the web.

serviceId

Gets the service ID of the linked entity data domain whose refresh mode was changed.

serviceId: number;

Property Value

number

Remarks

API set: ExcelApi 1.19

This property isn't supported in Excel on the web.

source

Gets the source of the event. See Excel.EventSource for details.

source: Excel.EventSource | "Local" | "Remote";

Property Value

Excel.EventSource | "Local" | "Remote"

Remarks

API set: ExcelApi 1.19

This property isn't supported in Excel on the web.

type

Gets the type of the event. See Excel.EventType for details.

type: "LinkedEntityDataDomainRefreshModeChanged";

Property Value

"LinkedEntityDataDomainRefreshModeChanged"

Remarks

API set: ExcelApi 1.19

This property isn't supported in Excel on the web.