Excel.CommentCollection class

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Comment[];

Valor de propiedad

Crea un nuevo comentario con el contenido específico de la celda. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.

add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");

    // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
    sheet.comments.add("A2", "TODO: add data.");
    await context.sync();
});

Crea un nuevo comentario con el contenido específico de la celda. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.

add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Obtiene el número de comentarios de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Obtiene un comentario de la colección en función de su identificador.

getItem(commentId: string): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Obtiene un comentario de la colección en función de su posición.

getItemAt(index: number): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-resolution.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = false;
    await context.sync();
});

Obtiene el comentario de la celda especificada. Si no hay ningún comentario en la celda, se produce un error.

getItemByCell(cellAddress: Range | string): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A1");
    const replyCount = comment.replies.getCount();
    // Sync to get the current number of comment replies.
    await context.sync();

    // Get the last comment reply in the comment thread.
    const reply = comment.replies.getItemAt(replyCount.value - 1);
    reply.load(["authorEmail", "authorName", "creationDate"]);
    // Sync to load the reply metadata.
    await context.sync();

    console.log(`Latest reply: ${reply.creationDate.toDateString()}: ${reply.authorName} ${reply.authorEmail})`);
    await context.sync();
});

Obtiene el comentario al que está conectada la respuesta dada.

getItemByReplyId(replyId: string): Excel.Comment;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.10

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.CommentCollection;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection;

Parámetros

Devoluciones

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.CommentCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CommentCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.

toJSON(): Excel.Interfaces.CommentCollectionData;

Devoluciones