Excel.CommentChangedEventArgs interface

Paquet:
excel

Se produit lorsque des commentaires existants sont modifiés.

Remarques

Jeu d’API : ExcelApi 1.12

Utilisateur

Exemples

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

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

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

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

Propriétés

changeType

Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché.
commentDetails

Obtenir 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 Excel.EventSource plus de détails.
type

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

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

Détails de la propriété

changeType

Obtient le type de modification qui représente la façon dont l’événement modifié est déclenché.

changeType: Excel.CommentChangeType | "CommentEdited" | "CommentResolved" | "CommentReopened" | "ReplyAdded" | "ReplyDeleted" | "ReplyEdited";

Valeur de propriété

Excel.CommentChangeType | "CommentEdited" | "CommentResolved" | "CommentReopened" | "ReplyAdded" | "ReplyDeleted" | "ReplyEdited"

Remarques

Jeu d’API : ExcelApi 1.12

commentDetails

Obtenir 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

Jeu d’API : ExcelApi 1.12

source

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

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

Valeur de propriété

Excel.EventSource | "Local" | "Remote"

Remarques

Jeu d’API : ExcelApi 1.12

type

Obtient le type de l’événement. Pour Excel.EventType plus de détails.

type: "CommentChanged";

Valeur de propriété

"CommentChanged"

Remarques

Jeu 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

Jeu d’API : ExcelApi 1.12