Excel.WorksheetChangedEventArgs interface

Ruft die Bereichsadresse ab, die den geänderten Bereich eines bestimmten Arbeitsblatts darstellt.

address: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Stellt eine Änderung der Richtung dar, in die die Zellen in einem Arbeitsblatt verschoben werden, wenn eine Zelle oder Zellen gelöscht oder eingefügt werden. Dies umfasst die folgenden beiden Szenarien. 1. Die Richtung (z. B. nach unten oder rechts), in der vorhandene Zellen verschoben werden, wenn eine oder mehrere neue Zellen in ein Arbeitsblatt eingefügt werden. 2. Die Richtung (z. B. nach oben oder nach links), in der die verbleibenden Zellen verschoben werden, wenn eine oder mehrere Zellen aus einem Arbeitsblatt gelöscht werden.

changeDirectionState: Excel.ChangeDirectionState;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.14 ]

Beispiele

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

async function onChange(event: Excel.WorksheetChangedEventArgs) {
    // This function is an event handler that returns the address, trigger source, 
    // and insert or delete shift directions of the change.
    await Excel.run(async (context) => {
        // Return the address where change occurred.
        console.log(`Handler for worksheet onChanged event has been triggered.`);
        console.log(`    Data changed address: ` + event.address);

        // Return the source of the event that triggered the change.
        console.log(`    Data change trigger source: ` + event.triggerSource);

        // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. 
        // If one has a value, then the other will return undefined.

        // If the insert shift direction is defined, return it.
        if (event.changeDirectionState.insertShiftDirection) {
            console.log(`    Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
        }

        // If the delete shift direction is defined, return it.
        if (event.changeDirectionState.deleteShiftDirection) {
            console.log(`    Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
        }
    });
}  

...

// This function deletes data from a range and sets the delete shift direction to "up".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("A5:F5");
    range.delete(Excel.DeleteShiftDirection.up);
});

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

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Stellt die Informationen zum Änderungsdetails dar. 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.

details: Excel.ChangedEventDetail;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Beispiele

// This function would be used as an event handler for the Worksheet.onChanged event.
async function onWorksheetChanged(eventArgs) {
    await Excel.run(async (context) => {
        const details = eventArgs.details;
        const address = eventArgs.address;

        // Print the before and after types and values to the console.
        console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
            + ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
        await context.sync();
    });
}

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

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Stellt die Triggerquelle des Ereignisses dar. Gibt beispielsweise an, ob dieses lokale Add-In das Ereignis auslöst.

triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.14 ]

Beispiele

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

async function onChange(event: Excel.WorksheetChangedEventArgs) {
    // This function is an event handler that returns the address, trigger source, 
    // and insert or delete shift directions of the change.
    await Excel.run(async (context) => {
        // Return the address where change occurred.
        console.log(`Handler for worksheet onChanged event has been triggered.`);
        console.log(`    Data changed address: ` + event.address);

        // Return the source of the event that triggered the change.
        console.log(`    Data change trigger source: ` + event.triggerSource);

        // Note：insertShiftDirection and deleteShiftDirection are exclusive and both enums can't have a value at the same time. 
        // If one has a value, then the other will return undefined.

        // If the insert shift direction is defined, return it.
        if (event.changeDirectionState.insertShiftDirection) {
            console.log(`    Cells inserted shift direction: ` + event.changeDirectionState.insertShiftDirection);
        }

        // If the delete shift direction is defined, return it.
        if (event.changeDirectionState.deleteShiftDirection) {
            console.log(`    Cells deleted shift direction: ` + event.changeDirectionState.deleteShiftDirection);
        }
    });
}  

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

type: "WorksheetChanged";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

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

worksheetId: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Ruft den Bereich ab, der den geänderten Bereich eines bestimmten Arbeitsblatts darstellt.

[ API-Satz: ExcelApi 1.8 ]

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

Parameter

Gibt zurück

Ruft den Bereich ab, der den geänderten Bereich eines bestimmten Arbeitsblatts darstellt. Möglicherweise wird ein NULL-Objekt zurückgegeben.

[ API-Satz: ExcelApi 1.8 ]

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

Parameter

Gibt zurück