Excel.CommentRichContent interface

Paquet:
excel

Représente le contenu d’un commentaire ou d’une réponse de commentaire. Le contenu enrichi inclut la chaîne de texte et tout autre objet contenu dans le corps du commentaire, tels que les mentions.

Remarques

Jeu d’API : ExcelApi 1.11

Utilisateur

Propriétés

mentions

Tableau contenant toutes les entités (par exemple, les personnes) mentionnées dans le commentaire.
richContent

Spécifie le contenu enrichi du commentaire (par exemple, contenu de commentaire avec mentions, la première entité mentionnée a un attribut ID de 0 et la deuxième entité mentionnée a un attribut ID de 1).

Détails de la propriété

mentions

Tableau contenant toutes les entités (par exemple, les personnes) mentionnées dans le commentaire.

mentions?: Excel.CommentMention[];

Valeur de propriété

Excel.CommentMention[]

Remarques

Jeu d’API : ExcelApi 1.11

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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

Spécifie le contenu enrichi du commentaire (par exemple, contenu de commentaire avec mentions, la première entité mentionnée a un attribut ID de 0 et la deuxième entité mentionnée a un attribut ID de 1).

richContent: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.11