Excel.WorksheetColumnSortedEventArgs 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 column-sorted event and its related worksheet.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

address

Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

source

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheetId

Gets the id of the worksheet where the sorting happened.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

address: string;

Property Value

string

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.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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

Property Value

Excel.EventSource | "Local" | "Remote"

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.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type: "WorksheetColumnSorted";

Property Value

"WorksheetColumnSorted"

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.

Gets the id of the worksheet where the sorting happened.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheetId: string;

Property Value

string