Excel.CommentRichContent interface

  • リファレンス
パッケージ:
excel

コメントまたはコメントの返信に含まれるコンテンツを表します。 リッチ コンテンツは、テキスト文字列とコメント本文に含まれるその他のオブジェクト (メンションなど) を妨げます。

注釈

[ API セット: ExcelApi 1.11 ]

プロパティ

mentions

コメント内で言及されているすべてのエンティティ (people など) を含む配列。
richContent

コメントのリッチ コンテンツを指定します (たとえば、メンションを含むコメント コンテンツ、最初のメンションエンティティの ID 属性は 0、2 番目のメンションエンティティの ID 属性は 1 です)。

プロパティの詳細

mentions

コメント内で言及されているすべてのエンティティ (people など) を含む配列。

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、2 番目のメンションエンティティの ID 属性は 1 です)。

richContent: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.11 ]