Compartilhar via


Excel.CommentChangedEventArgs interface

Ocorre quando os comentários existentes são alterados.

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

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

Propriedades

changeType

Obtém o tipo de alteração que representa a forma como o evento alterado é acionado.

commentDetails

Obtenha a CommentDetail matriz que contém o ID de comentário e os IDs das respetivas respostas relacionadas.

source

Especifica a origem do evento. Veja Excel.EventSource para obter detalhes.

type

Obtém o tipo do evento. Veja Excel.EventType para obter detalhes.

worksheetId

Obtém o ID da folha de cálculo na qual o evento ocorreu.

Detalhes da propriedade

changeType

Obtém o tipo de alteração que representa a forma como o evento alterado é acionado.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

commentDetails

Obtenha a CommentDetail matriz que contém o ID de comentário e os IDs das respetivas respostas relacionadas.

commentDetails: Excel.CommentDetail[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

source

Especifica a origem do evento. Veja Excel.EventSource para obter detalhes.

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

Valor da propriedade

Excel.EventSource | "Local" | "Remote"

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

type

Obtém o tipo do evento. Veja Excel.EventType para obter detalhes.

type: "CommentChanged";

Valor da propriedade

"CommentChanged"

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

worksheetId

Obtém o ID da folha de cálculo na qual o evento ocorreu.

worksheetId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]