Edit

Share via


Excel.WorksheetCalculationBusyEventArgs interface

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 ranges that raised the onCalculationBusy event, which triggers when the calculation is in progress in a worksheet.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

address

The address of the ranges that began calculation. If multiple ranges began calculation, the string is a comma-separated list of those range addresses.

source

The source of the event. It can be local or remote (through co-authoring).

type

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

worksheetId

The ID of the worksheet within which the calculation occurred.

Property Details

address

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 address of the ranges that began calculation. If multiple ranges began calculation, the string is a comma-separated list of those range addresses.

address: string;

Property Value

string

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.

The source of the event. It can be local or remote (through co-authoring).

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: "WorksheetCalculationBusy";

Property Value

"WorksheetCalculationBusy"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheetId

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 ID of the worksheet within which the calculation occurred.

worksheetId: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]