Edit

Share via

Excel.RefreshModeChangedEventArgs 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.

Represents information about a newly added linked data type, such as source and ID.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

refreshMode

The linked data type refresh mode.
serviceId

The unique ID of the object 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

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.

The linked data type refresh mode.

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

Property Value

Excel.LinkedDataTypeRefreshMode | "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.

The unique ID of the object 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: "LinkedDataTypeRefreshModeChanged";

Property Value

"LinkedDataTypeRefreshModeChanged"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]