Excel.CommentAddedEventArgs interface

Paquet:

excel

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

Remarques

Ensemble d’API : ExcelApi 1.12

Utilisateur

• Excel.CommentCollection : onAdded

Exemples

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

async function commentAdded(event: Excel.CommentAddedEventArgs) {
    // Retrieve the added comment using the comment ID.
    // Note: This function assumes only a single comment is added at a time.
    await Excel.run(async (context) => {
        const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);

        // Load the added comment's data.
        addedComment.load(["content", "authorName", "creationDate"]);
        await context.sync();

        // Print out the added comment's data.
        console.log(`A comment was added:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
        console.log(`    Comment content: ${addedComment.content}`);
        console.log(`    Comment author: ${addedComment.authorName}`);
        console.log(`    Creation date: ${addedComment.creationDate}`);
    });
}

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: "CommentAdded";

Valeur de propriété

"CommentAdded"

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