Excel.TableChangedEventArgs interface
変更されたイベントを発生させたテーブルに関する情報を提供します。
注釈
プロパティ
| address | 特定のワークシート上のテーブル内で変更されたエリアを表すアドレスを取得します。 |
| change |
変更されたイベントのトリガー方法を表す変更の種類を取得します。 詳細は「 |
| details | 変更の詳細に関する情報を取得します。 このプロパティは、変更されたイベントが 1 つのセルでトリガーされたときに取得できます。 変更されたイベントが複数のセルでトリガーされた場合、このプロパティを取得できません。 |
| source | イベントのソースを取得します。 詳細は「 |
| table |
データが変更されたテーブルの ID を取得します。 |
| type | イベントの種類を取得します。 詳細は「 |
| worksheet |
データが変更されたワークシートの ID を取得します。 |
メソッド
| get |
特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。 |
| get |
特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。 null オブジェクトを返すこともあります。 |
プロパティの詳細
address
changeType
変更されたイベントのトリガー方法を表す変更の種類を取得します。 詳細は「Excel.DataChangeType」をご覧ください。
changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";プロパティ値
Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"
注釈
details
変更の詳細に関する情報を取得します。 このプロパティは、変更されたイベントが 1 つのセルでトリガーされたときに取得できます。 変更されたイベントが複数のセルでトリガーされた場合、このプロパティを取得できません。
details: Excel.ChangedEventDetail;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-change-event-details.yaml
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
イベントのソースを取得します。 詳細は「Excel.EventSource」をご覧ください。
source: Excel.EventSource | "Local" | "Remote";プロパティ値
Excel.EventSource | "Local" | "Remote"
注釈
tableId
データが変更されたテーブルの ID を取得します。
tableId: string;プロパティ値
string
注釈
例
// 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"
注釈
worksheetId
データが変更されたワークシートの ID を取得します。
worksheetId: string;プロパティ値
string
注釈
例
// 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);
});
}
メソッドの詳細
getRange(ctx)
特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。
getRange(ctx: Excel.RequestContext): Excel.Range;パラメーター
戻り値
getRangeOrNullObject(ctx)
特定のワークシート上のテーブルの変更された領域を表す範囲を取得します。 null オブジェクトを返すこともあります。
getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;パラメーター
戻り値
Office Add-ins