Edit

Share via

Excel.WorksheetFormulaChangedEventArgs interface

Package:
excel

Provides information about the worksheet and formulas that raised the formula changed event.

Remarks

[ API set: ExcelApi 1.13 ]

Properties

formulaDetails

Gets an array of FormulaChangedEventDetail objects, which contain the details about the all of the changed formulas.

If the number of changed formulas or the size of the changed formula text exceeds a size limit, formulaDetails returns undefined. This indicates that something on the sheet has changed, but the details cannot be reported.
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

Gets the ID of the worksheet in which the formula changed.

Property Details

formulaDetails

Gets an array of FormulaChangedEventDetail objects, which contain the details about the all of the changed formulas.

If the number of changed formulas or the size of the changed formula text exceeds a size limit, formulaDetails returns undefined. This indicates that something on the sheet has changed, but the details cannot be reported.

formulaDetails: Excel.FormulaChangedEventDetail[];

Property Value

Excel.FormulaChangedEventDetail[]

Remarks

[ API set: ExcelApi 1.13 ]

source

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 1.13 ]

type

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

type: "WorksheetFormulaChanged";

Property Value

"WorksheetFormulaChanged"

Remarks

[ API set: ExcelApi 1.13 ]

worksheetId

Gets the ID of the worksheet in which the formula changed.

worksheetId: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.13 ]