Excel.TableSelectionChangedEventArgs interface

Provides information about the table that raised the SelectionChanged event.

[ API set: ExcelApi 1.7 ]

Properties

address

Gets the range address that represents the selected area of the table on a specific worksheet.

[ API set: ExcelApi 1.7 ]

isInsideTable

Indicates if the selection is inside a table, address will be useless if IsInsideTable is false.

[ API set: ExcelApi 1.7 ]

tableId

Gets the id of the table in which the selection changed.

[ API set: ExcelApi 1.7 ]

type

Gets the type of the event. See Excel.EventType for details. Read-only.

[ API set: ExcelApi 1.7 ]

worksheetId

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

[ API set: ExcelApi 1.7 ]

Property Details

address

Gets the range address that represents the selected area of the table on a specific worksheet.

[ API set: ExcelApi 1.7 ]

address: string;
Property Value
string

Examples

async function onSelectionChange(args) {
    await Excel.run(async (context) => {
        console.log("Handler for table onSelectionChanged event has been triggered.  The new selection is : " + args.address);
    });
}

isInsideTable

Indicates if the selection is inside a table, address will be useless if IsInsideTable is false.

[ API set: ExcelApi 1.7 ]

isInsideTable: boolean;
Property Value
boolean

tableId

Gets the id of the table in which the selection changed.

[ API set: ExcelApi 1.7 ]

tableId: string;
Property Value
string

type

Gets the type of the event. See Excel.EventType for details. Read-only.

[ API set: ExcelApi 1.7 ]

type: "TableSelectionChanged";
Property Value
"TableSelectionChanged"

worksheetId

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

[ API set: ExcelApi 1.7 ]

worksheetId: string;
Property Value
string