Edit

Share via

Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs interface

  • Reference
Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

refreshMode

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

serviceId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

serviceId: number;

Property Value

number

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

source

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

type: "LinkedEntityDataDomainRefreshModeChanged";

Property Value

"LinkedEntityDataDomainRefreshModeChanged"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]