Excel.CommentRichContent interface

Пакет:

excel

Представляет содержимое, содержащееся в комментарии или ответе примечания. Форматированный контент включает текстовую строку и любые другие объекты, содержащиеся в тексте комментария, например упоминания.

Комментарии

[ Набор API: ExcelApi 1.11 ]

Свойства

mentions	Массив, содержащий все сущности (например, люди), упомянутые в комментарии.
richContent	Задает расширенное содержимое комментария (например, содержимое комментария с упоминаниями, первая упомянутая сущность имеет атрибут ID 0, а вторая указанная сущность имеет атрибут ID 1).

Сведения о свойстве

mentions

Массив, содержащий все сущности (например, люди), упомянутые в комментарии.

mentions?: Excel.CommentMention[];

Значение свойства

Excel.CommentMention[]

Комментарии

[ Набор API: ExcelApi 1.11 ]

Примеры

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const mention = {
        email: "kakri@contoso.com",
        id: 0,
        name: "Kate Kristensen"
    };

    // This will tag the mention's name using the '@' syntax.
    // They will be notified via email.
    const commentBody = {
        mentions: [mention],
        richContent: '<at id="0">' + mention.name + "</at> -  Can you take a look?"
    };

    // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
    sheet.comments.add("A1", commentBody, Excel.ContentType.mention);
    await context.sync();
});

richContent

Задает расширенное содержимое комментария (например, содержимое комментария с упоминаниями, первая упомянутая сущность имеет атрибут ID 0, а вторая указанная сущность имеет атрибут ID 1).

richContent: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.11 ]