Excel.TableChangedEventArgs interface

パッケージ:

excel

変更されたイベントを発生させたテーブルに関する情報を提供します。

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

address	特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。
changeType	変更されたイベントのトリガー方法を表す変更の種類を取得します。 詳細は「Excel.DataChangeType」をご覧ください。
source	イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。
tableId	データが変更されたテーブルの ID を取得します。
type	イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。
worksheetId	データが変更されたワークシートの ID を取得します。

プロパティの詳細

address

特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。

address: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

changeType

変更されたイベントのトリガー方法を表す変更の種類を取得します。 詳細は「Excel.DataChangeType」をご覧ください。

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

プロパティ値

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

注釈

[ API セット: ExcelApi 1.7 ]

source

イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。

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

プロパティ値

Excel.EventSource | "Local" | "Remote"

注釈

[ API セット: ExcelApi 1.7 ]

tableId

データが変更されたテーブルの ID を取得します。

tableId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

例

// 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);
    });
}

type

イベントの種類を取得します。 詳細は「Excel.EventType」をご覧ください。

type: "TableChanged";

プロパティ値

"TableChanged"

注釈

[ API セット: ExcelApi 1.7 ]

worksheetId

データが変更されたワークシートの ID を取得します。

worksheetId: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

例

// 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);
    });
}