ExcelScript.CommentMention interface

Paket:

ExcelScript

Stellt die Entität dar, die in Kommentaren erwähnt wird.

Hinweise

Beispiele

/**
 * 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);
}

Eigenschaften

email	Die E-Mail-Adresse der Entität, die in einem Kommentar erwähnt wird.
id	Die ID der Entität. Die ID entspricht einer der IDs in CommentRichContent.richContent.
name	Der Name der Entität, die in einem Kommentar erwähnt wird.

Details zur Eigenschaft

email

Die E-Mail-Adresse der Entität, die in einem Kommentar erwähnt wird.

email: string;

Eigenschaftswert

string

id

Die ID der Entität. Die ID entspricht einer der IDs in CommentRichContent.richContent.

id: number;

Eigenschaftswert

number

name

Der Name der Entität, die in einem Kommentar erwähnt wird.

name: string;

Eigenschaftswert

string