Excel.TableChangedEventArgs interface

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

address: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

tableId: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

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

type: "TableChanged";

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

worksheetId: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml

async function onChange(event) {
    await Excel.run(async (context) => {
        let table = context.workbook.tables.getItem(event.tableId);
        let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
        worksheet.load("name");

        await context.sync();

        console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
        console.log("Table Id : " + event.tableId);
        console.log("Worksheet Id : " + worksheet.name);
    });
}

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

[ API set: ExcelApi 1.8 ]

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

Parameters

Returns

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

[ API set: ExcelApi 1.8 ]

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

Parameters

Returns