Excel.TableChangedEventArgs interface

Paket:

excel

Stellt Informationen zu der Tabelle bereit, die das geänderte Ereignis ausgelöst hat.

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Eigenschaften

address	Ruft die Adresse ab, die den geänderten Bereich der Tabelle auf einem bestimmten Arbeitsblatt darstellt.
changeType	Ruft den Änderungstyp ab, der angibt, wie das geänderte Ereignis ausgelöst wird. Weitere Informationen finden Sie unter Excel.DataChangeType .
details	Ruft die Informationen zum Änderungsdetails ab. Diese Eigenschaft kann abgerufen werden, wenn das geänderte Ereignis in einer einzelnen Zelle ausgelöst wird. Wenn das geänderte Ereignis für mehrere Zellen ausgelöst wird, kann diese Eigenschaft nicht abgerufen werden.
source	Ruft die Quelle des Ereignisses ab. Weitere Informationen finden Sie unter Excel.EventSource .
tableId	Ruft die ID der Tabelle ab, in der die Daten geändert wurden.
type	Ruft den Typ des Ereignisses ab. Weitere Informationen finden Sie unter Excel.EventType .
worksheetId	Ruft die ID des Arbeitsblatts ab, in dem die Daten geändert wurden.

Methoden

getRange(ctx)	Ruft den Bereich ab, der den geänderten Bereich einer Tabelle auf einem bestimmten Arbeitsblatt darstellt. [ API-Satz: ExcelApi 1.8 ]
getRangeOrNullObject(ctx)	Ruft den Bereich ab, der den geänderten Bereich einer Tabelle auf einem bestimmten Arbeitsblatt darstellt. Möglicherweise wird ein NULL-Objekt zurückgegeben. [ API-Satz: ExcelApi 1.8 ]

Details zur Eigenschaft

address

Ruft die Adresse ab, die den geänderten Bereich der Tabelle auf einem bestimmten Arbeitsblatt darstellt.

TypeScript

address: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

changeType

Ruft den Änderungstyp ab, der angibt, wie das geänderte Ereignis ausgelöst wird. Weitere Informationen finden Sie unter Excel.DataChangeType .

TypeScript

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.7 ]

details

Ruft die Informationen zum Änderungsdetails ab. Diese Eigenschaft kann abgerufen werden, wenn das geänderte Ereignis in einer einzelnen Zelle ausgelöst wird. Wenn das geänderte Ereignis für mehrere Zellen ausgelöst wird, kann diese Eigenschaft nicht abgerufen werden.

TypeScript

details: Excel.ChangedEventDetail;

Eigenschaftswert

Excel.ChangedEventDetail

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Beispiele

TypeScript

// 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

Ruft die Quelle des Ereignisses ab. Weitere Informationen finden Sie unter Excel.EventSource .

TypeScript

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

Eigenschaftswert

Excel.EventSource | "Local" | "Remote"

Hinweise

[ API-Satz: ExcelApi 1.7 ]

tableId

Ruft die ID der Tabelle ab, in der die Daten geändert wurden.

TypeScript

tableId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Beispiele

TypeScript

// 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

Ruft den Typ des Ereignisses ab. Weitere Informationen finden Sie unter Excel.EventType .

TypeScript

type: "TableChanged";

Eigenschaftswert

"TableChanged"

Hinweise

[ API-Satz: ExcelApi 1.7 ]

worksheetId

Ruft die ID des Arbeitsblatts ab, in dem die Daten geändert wurden.

TypeScript

worksheetId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Beispiele

TypeScript

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

Details zur Methode

getRange(ctx)

Ruft den Bereich ab, der den geänderten Bereich einer Tabelle auf einem bestimmten Arbeitsblatt darstellt.

[ API-Satz: ExcelApi 1.8 ]

TypeScript

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

Parameter

ctx

Excel.RequestContext

Gibt zurück

Excel.Range

getRangeOrNullObject(ctx)

Ruft den Bereich ab, der den geänderten Bereich einer Tabelle auf einem bestimmten Arbeitsblatt darstellt. Möglicherweise wird ein NULL-Objekt zurückgegeben.

[ API-Satz: ExcelApi 1.8 ]

TypeScript

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

Parameter

ctx

Excel.RequestContext

Gibt zurück

Excel.Range