Excel.TableChangedEventArgs interface

Changed イベントが発生したテーブルに関する情報を提供します。Provides information about the table that raised the Changed event.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

プロパティ

address

特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。Gets the address that represents the changed area of a table on a specific worksheet.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

changeType

Changed イベントがトリガーされる方法を表す変更の種類を取得します。Gets the change type that represents how the Changed event is triggered. 詳細については、「DataChangeType」を参照してください。See Excel.DataChangeType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

details

変更の詳細についての情報を表します。Represents the information about the change detail. このプロパティは、Changed イベントが1つのセルに対してトリガーされたときに取得できます。This property can be retrieved when the Changed event is triggered on a single cell. Changed イベントが複数のセルでトリガーされた場合、このプロパティは取得できません。If the Changed event is triggered on multiple cells, this property cannot be retrieved.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

source

イベントのソースを取得します。Gets the source of the event. 詳細については、Excel.EventSource をご覧ください。See Excel.EventSource for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

tableId

データが変更されたテーブルの ID を取得します。Gets the id of the table in which the data changed.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

type

イベントの種類を取得します。Gets the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

worksheetId

データが変更されたワークシートの ID を取得します。Gets the id of the worksheet in which the data changed.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

メソッド

getRange(ctx)

特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。Gets the range that represents the changed area of a table on a specific worksheet.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

getRangeOrNullObject(ctx)

特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。Gets the range that represents the changed area of a table on a specific worksheet. null オブジェクトを返すこともあります。It might return null object.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

プロパティの詳細

address

特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。Gets the address that represents the changed area of a table on a specific worksheet.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

address: string;

プロパティ値

string

changeType

Changed イベントがトリガーされる方法を表す変更の種類を取得します。Gets the change type that represents how the Changed event is triggered. 詳細については、「DataChangeType」を参照してください。See Excel.DataChangeType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

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

プロパティ値

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

details

変更の詳細についての情報を表します。Represents the information about the change detail. このプロパティは、Changed イベントが1つのセルに対してトリガーされたときに取得できます。This property can be retrieved when the Changed event is triggered on a single cell. Changed イベントが複数のセルでトリガーされた場合、このプロパティは取得できません。If the Changed event is triggered on multiple cells, this property cannot be retrieved.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

details: Excel.ChangedEventDetail;

プロパティ値

Examples

async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
          + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
    });
}

source

イベントのソースを取得します。Gets the source of the event. 詳細については、Excel.EventSource をご覧ください。See Excel.EventSource for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

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

プロパティ値

Excel.EventSource | "Local" | "Remote"

tableId

データが変更されたテーブルの ID を取得します。Gets the id of the table in which the data changed.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

tableId: string;

プロパティ値

string

Examples

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

イベントの種類を取得します。Gets the type of the event. 詳細については、Excel.EventType をご覧ください。See Excel.EventType for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

type: "TableChanged";

プロパティ値

"TableChanged"

worksheetId

データが変更されたワークシートの ID を取得します。Gets the id of the worksheet in which the data changed.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

worksheetId: string;

プロパティ値

string

Examples

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

メソッドの詳細

getRange(ctx)

特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。Gets the range that represents the changed area of a table on a specific worksheet.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

パラメーター

戻り値

getRangeOrNullObject(ctx)

特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。Gets the range that represents the changed area of a table on a specific worksheet. null オブジェクトを返すこともあります。It might return null object.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

パラメーター

戻り値