ExcelScript.CommentMention interface

Remarks

Used by

• ExcelScript.Comment: getMentions
• ExcelScript.CommentReply: getMentions
• ExcelScript.CommentRichContent: mentions

Examples

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

Properties

email

email: string;

id

id: number;

name

name: string;