Excel.WorksheetFormatChangedEventArgs interface

Package:

excel

Provides information about the worksheet format change event.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

address	Gets the range address that represents the changed area of a specific worksheet.
source	Gets the source of the event. See Excel.EventSource for details.
type	Gets the type of the event. See Excel.EventType for details.
worksheetId	Gets the ID of the worksheet in which the data changed.

Methods

getRange(ctx)	Gets the range that represents the changed area of a specific worksheet. [ API set: ExcelApi 1.9 ]
getRangeOrNullObject(ctx)	Gets the range that represents the changed area of a specific worksheet. It might return null object. [ API set: ExcelApi 1.9 ]

Property Details

address

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

address: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

source

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

type

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

type: "WorksheetFormatChanged";

Property Value

"WorksheetFormatChanged"

Remarks

[ API set: ExcelApi 1.9 ]

worksheetId

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

worksheetId: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

Method Details

getRange(ctx)

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

[ API set: ExcelApi 1.9 ]

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

Parameters

ctx

Excel.RequestContext

Returns

Excel.Range

getRangeOrNullObject(ctx)

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

[ API set: ExcelApi 1.9 ]

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

Parameters

ctx

Excel.RequestContext

Returns

Excel.Range