Excel.CommentDeletedEventArgs interface

Paquete:

excel

Proporciona información sobre los comentarios que generaron el evento de eliminación de comentario.

Comentarios

Conjunto de API: ExcelApi 1.12

Usada por

• Excel.CommentCollection: onDeleted

Ejemplos

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

Propiedades

commentDetails	Obtiene la CommentDetail matriz que contiene el identificador de comentario y los identificadores de sus respuestas relacionadas.
source	Especifica el origen del evento. Vea Excel.EventSource para más información.
type	Obtiene el tipo del evento. Vea Excel.EventType para más información.
worksheetId	Obtiene el identificador de la hoja de cálculo en la que se produjo el evento.

Detalles de las propiedades

commentDetails

Obtiene la CommentDetail matriz que contiene el identificador de comentario y los identificadores de sus respuestas relacionadas.

commentDetails: Excel.CommentDetail[];

Valor de propiedad

Excel.CommentDetail[]

Comentarios

Conjunto de API: ExcelApi 1.12

source

Especifica el origen del evento. Vea Excel.EventSource para más información.

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

Valor de propiedad

Excel.EventSource | "Local" | "Remote"

Comentarios

Conjunto de API: ExcelApi 1.12

type

Obtiene el tipo del evento. Vea Excel.EventType para más información.

type: "CommentDeleted";

Valor de propiedad

"CommentDeleted"

Comentarios

Conjunto de API: ExcelApi 1.12

worksheetId

Obtiene el identificador de la hoja de cálculo en la que se produjo el evento.

worksheetId: string;

Valor de propiedad

string

Comentarios

Conjunto de API: ExcelApi 1.12