Freigeben über


Excel.CommentDeletedEventArgs interface

Stellt Informationen zu den Kommentaren bereit, die das Kommentarlöschereignis ausgelöst haben.

Hinweise

[ API-Satz: ExcelApi 1.12 ]

Beispiele

async function registerEventHandlers() {
    await Excel.run(async (context) => {
        // Register the onDeleted comment event handler.
        const comments = context.workbook.worksheets.getActiveWorksheet().comments;
        comments.onDeleted.add(commentDeleted);
        await context.sync();
    });
}

async function commentDeleted(event: Excel.CommentDeletedEventArgs) {
    // Print out the deleted comment's ID.
    // Note: This function assumes only a single comment is deleted at a time.
    await Excel.run(async (context) => {
        console.log(`A comment was deleted:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
    });
}

Eigenschaften

commentDetails

Ruft das CommentDetail Array ab, das die Kommentar-ID und die IDs der zugehörigen Antworten enthält.

source

Gibt die Quelle des Ereignisses an. Weitere Informationen finden Sie unter Excel.EventSource .

type

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

worksheetId

Ruft die ID des Arbeitsblatts ab, in dem das Ereignis aufgetreten ist.

Details zur Eigenschaft

commentDetails

Ruft das CommentDetail Array ab, das die Kommentar-ID und die IDs der zugehörigen Antworten enthält.

commentDetails: Excel.CommentDetail[];

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.12 ]

source

Gibt die Quelle des Ereignisses an. Weitere Informationen finden Sie unter Excel.EventSource .

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

Eigenschaftswert

Excel.EventSource | "Local" | "Remote"

Hinweise

[ API-Satz: ExcelApi 1.12 ]

type

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

type: "CommentDeleted";

Eigenschaftswert

"CommentDeleted"

Hinweise

[ API-Satz: ExcelApi 1.12 ]

worksheetId

Ruft die ID des Arbeitsblatts ab, in dem das Ereignis aufgetreten ist.

worksheetId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.12 ]