Excel.CommentDeletedEventArgs interface

Paquet:
excel

Fournit des informations sur les commentaires qui ont déclenché l’événement de suppression de commentaire.

Remarques

Ensemble d’API : ExcelApi 1.12

Utilisateur

Exemples

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

Propriétés

commentDetails

Obtient le CommentDetail tableau qui contient l’ID de commentaire et les ID de ses réponses associées.
source

Spécifie la source de l’événement. Pour plus d’informations, consultez Excel.EventSource .
type

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .
worksheetId

Obtient l’ID de la feuille de calcul dans laquelle l’événement s’est produit.

Détails de la propriété

commentDetails

Obtient le CommentDetail tableau qui contient l’ID de commentaire et les ID de ses réponses associées.

commentDetails: Excel.CommentDetail[];

Valeur de propriété

Excel.CommentDetail[]

Remarques

Ensemble d’API : ExcelApi 1.12

source

Spécifie la source de l’événement. Pour plus d’informations, consultez Excel.EventSource .

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

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

Ensemble d’API : ExcelApi 1.12

type

Obtient le type de l’événement. Pour plus d’informations, consultez Excel.EventType .

type: "CommentDeleted";

Valeur de propriété

"CommentDeleted"

Remarques

Ensemble d’API : ExcelApi 1.12

worksheetId

Obtient l’ID de la feuille de calcul dans laquelle l’événement s’est produit.

worksheetId: string;

Valeur de propriété

string

Remarques

Ensemble d’API : ExcelApi 1.12