Excel.CommentRichContent interface

Pacote:

excel

Representa o conteúdo contido numa resposta de comentário ou comentário. O conteúdo formatado incude a cadeia de texto e quaisquer outros objetos contidos no corpo do comentário, como menções.

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Propriedades

mentions	Uma matriz que contém todas as entidades (por exemplo, pessoas) mencionadas no comentário.
richContent	Especifica o conteúdo avançado do comentário (por exemplo, conteúdo de comentário com menções, a primeira entidade mencionada tem um atributo de ID de 0 e a segunda entidade mencionada tem um atributo de ID de 1).

Detalhes da propriedade

mentions

Uma matriz que contém todas as entidades (por exemplo, pessoas) mencionadas no comentário.

mentions?: Excel.CommentMention[];

Valor da propriedade

Excel.CommentMention[]

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Exemplos

// 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

Especifica o conteúdo avançado do comentário (por exemplo, conteúdo de comentário com menções, a primeira entidade mencionada tem um atributo de ID de 0 e a segunda entidade mencionada tem um atributo de ID de 1).

richContent: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.11 ]