Excel.Comment class

Obtiene el correo electrónico del autor del comentario.

readonly authorEmail: string;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.10

Obtiene el nombre del autor del comentario.

readonly authorName: string;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.10

El contenido del comentario. La cadena es de texto sin formato.

content: string;

Valor de propiedad

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");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

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 la hora de creación del comentario. Devuelve null si el comentario se convirtió a partir de una nota, ya que el comentario no tiene una fecha de creación.

readonly creationDate: Date;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.10

Especifica el identificador del comentario.

readonly id: string;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.10

Indica una colección de objetos de respuesta asociados con el comentario.

readonly replies: Excel.CommentReplyCollection;

Valor de propiedad

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) => {
    // Adds a reply to the first comment in this worksheet.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment: Excel.Comment = sheet.comments.getItemAt(0);
    comment.replies.add("Add content to this worksheet.");
    await context.sync();
});

Elimina el comentario y todas las respuestas conectadas.

delete(): void;

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) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

Obtiene la celda donde se encuentra este comentario.

getLocation(): Excel.Range;

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.CommentLoadOptions): Excel.Comment;

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.Comment;

Parámetros

Devoluciones

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 comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

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

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Comment;

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.Comment): void;

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.Comment es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CommentData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.CommentData;

Devoluciones