ExcelScript.CommentMention interface

Paquete:

ExcelScript

Representa la entidad que se menciona en los comentarios.

Comentarios

Ejemplos

/**
 * This sample creates a comment that mentions a specific person.
 * That person will get a notification and link to the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const cell = currentSheet.getCell(0,0);
  
  /* Create a CommentMention object for the comment.
   *
   * A CommentMention's properties are:
   * `name`: The name of the person being mentioned.
   * `id`: The zero-based index of this mention in the comment.
   * `email`: The email address of the person being mentioned. 
   */
  const mention: ExcelScript.CommentMention = {
    name: "Alex",
    id: 0,
    email: "alex@contoso.com"
  };

  /* Create comment content that uses the mention. 
   * The `<at id="0">` syntax embeds the mention with ID 0 in the comment text. 
   * The name is displayed in the comment, 
   * while an email is sent to the given address.
   */
  const content: ExcelScript.CommentRichContent = {
    richContent: '<at id="0">' + mention.name + "</at> - Hello!",
    mentions: [mention]
  };

  // Add the comment.
  currentSheet.addComment(cell, content, ExcelScript.ContentType.mention);
}

Propiedades

email	Dirección de correo electrónico de la entidad que se menciona en un comentario.
id	Identificador de la entidad. El identificador coincide con uno de los identificadores de CommentRichContent.richContent.
name	Nombre de la entidad que se menciona en un comentario.

Detalles de las propiedades

email

Dirección de correo electrónico de la entidad que se menciona en un comentario.

email: string;

Valor de propiedad

string

id

Identificador de la entidad. El identificador coincide con uno de los identificadores de CommentRichContent.richContent.

id: number;

Valor de propiedad

number

name

Nombre de la entidad que se menciona en un comentario.

name: string;

Valor de propiedad

string