Excel.WorksheetChangedEventArgs interface

Provides information about the worksheet that raised the Changed event.

[ API set: ExcelApi 1.7 ]

Properties

address

Gets the range address that represents the changed area of a specific worksheet.

[ API set: ExcelApi 1.7 ]

changeType

Gets the change type that represents how the Changed event is triggered. See Excel.DataChangeType for details.

[ API set: ExcelApi 1.7 ]

source

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

[ API set: ExcelApi 1.7 ]

type

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

[ API set: ExcelApi 1.7 ]

worksheetId

Gets the id of the worksheet in which the data changed.

[ API set: ExcelApi 1.7 ]

Methods

getRange(ctx)

Gets the range that represents the changed area of a specific worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getRangeOrNullObject(ctx)

Gets the range that represents the changed area of a specific worksheet. It might return null object.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Property Details

address

Gets the range address that represents the changed area of a specific worksheet.

[ API set: ExcelApi 1.7 ]

address: string;
Property Value
string

changeType

Gets the change type that represents how the Changed event is triggered. See Excel.DataChangeType for details.

[ API set: ExcelApi 1.7 ]

changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";
Property Value
Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"

source

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

[ API set: ExcelApi 1.7 ]

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

type

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

[ API set: ExcelApi 1.7 ]

type: "WorksheetChanged";
Property Value
"WorksheetChanged"

worksheetId

Gets the id of the worksheet in which the data changed.

[ API set: ExcelApi 1.7 ]

worksheetId: string;
Property Value
string

Method Details

getRange(ctx)

Gets the range that represents the changed area of a specific worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getRange(ctx: Excel.RequestContext): Excel.Range;
Parameters
Returns

getRangeOrNullObject(ctx)

Gets the range that represents the changed area of a specific worksheet. It might return null object.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;
Parameters
Returns