次の方法で共有


Excel.Comment class

ブック内のコメントを表します。

Extends

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

authorEmail

コメント作成者のメール アドレスを取得します。

authorName

コメント作成者の名前を取得します。

content

コメントの内容。 文字列はプレーン テキストです。

contentType

コメントのコンテンツ タイプを取得します。

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

creationDate

コメントの作成日時を取得します。 コメントの null 作成日がないため、コメントがノートから変換された場合は を返します。

id

コメント識別子を指定します。

mentions

コメントに記載されているエンティティ (people など) を取得します。

replies

コメントに関連付けられている返信オブジェクトのコレクションを表します。

resolved

コメント スレッドの状態。 の true 値は、コメント スレッドが解決されることを意味します。

richContent

リッチ コメント コンテンツ (コメント内のメンションなど) を取得します。 この文字列は、エンド ユーザーに表示されるものではありません。 アドインでは、これを使用してリッチ コメント コンテンツを解析する必要があります。

メソッド

assignTask(assignee)

コメントにアタッチされたタスクを、割り当て先として指定されたユーザーに割り当てます。 タスクがない場合は、タスクが作成されます。

delete()

コメントと接続されているすべての応答を削除します。

getLocation()

このコメントが配置されているセルを取得します。

getTask()

このコメントに関連付けられているタスクを取得します。 コメント スレッドのタスクがない場合は、 ItemNotFound 例外がスローされます。

getTaskOrNullObject()

このコメントに関連付けられているタスクを取得します。 コメント スレッドのタスクがない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Comment オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.CommentData型指定) を返します。

updateMentions(contentWithMentions)

特別に書式設定された文字列とメンションのリストを含むコメント コンテンツを更新します。

プロパティの詳細

authorEmail

コメント作成者のメール アドレスを取得します。

readonly authorEmail: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

authorName

コメント作成者の名前を取得します。

readonly authorName: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

content

コメントの内容。 文字列はプレーン テキストです。

content: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

contentType

コメントのコンテンツ タイプを取得します。

readonly contentType: Excel.ContentType | "Plain" | "Mention";

プロパティ値

Excel.ContentType | "Plain" | "Mention"

注釈

[ API セット: ExcelApi 1.12 ]

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

creationDate

コメントの作成日時を取得します。 コメントの null 作成日がないため、コメントがノートから変換された場合は を返します。

readonly creationDate: Date;

プロパティ値

Date

注釈

[ API セット: ExcelApi 1.10 ]

id

コメント識別子を指定します。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

mentions

コメントに記載されているエンティティ (people など) を取得します。

readonly mentions: Excel.CommentMention[];

プロパティ値

注釈

[ API セット: ExcelApi 1.11 ]

replies

コメントに関連付けられている返信オブジェクトのコレクションを表します。

readonly replies: Excel.CommentReplyCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.10 ]

resolved

コメント スレッドの状態。 の true 値は、コメント スレッドが解決されることを意味します。

resolved: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.11 ]

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = true;
    await context.sync();
});

richContent

リッチ コメント コンテンツ (コメント内のメンションなど) を取得します。 この文字列は、エンド ユーザーに表示されるものではありません。 アドインでは、これを使用してリッチ コメント コンテンツを解析する必要があります。

readonly richContent: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.11 ]

メソッドの詳細

assignTask(assignee)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

コメントにアタッチされたタスクを、割り当て先として指定されたユーザーに割り当てます。 タスクがない場合は、タスクが作成されます。

assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;

パラメーター

assignee
Excel.EmailIdentity

担当者のユーザー ID 情報。

戻り値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

delete()

コメントと接続されているすべての応答を削除します。

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.10 ]

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

await Excel.run(async (context) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

getLocation()

このコメントが配置されているセルを取得します。

getLocation(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.10 ]

getTask()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコメントに関連付けられているタスクを取得します。 コメント スレッドのタスクがない場合は、 ItemNotFound 例外がスローされます。

getTask(): Excel.DocumentTask;

戻り値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

getTaskOrNullObject()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このコメントに関連付けられているタスクを取得します。 コメント スレッドのタスクがない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getTaskOrNullObject(): Excel.DocumentTask;

戻り値

注釈

[ API セット: ExcelApi BETA (プレビューのみ) ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;

パラメーター

options
Excel.Interfaces.CommentLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.Comment;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

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

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

    console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
    await context.sync();
});

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Comment;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Excel.Interfaces.CommentUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Comment): void;

パラメーター

properties
Excel.Comment

戻り値

void

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.Comment オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.CommentData型指定) を返します。

toJSON(): Excel.Interfaces.CommentData;

戻り値

updateMentions(contentWithMentions)

特別に書式設定された文字列とメンションのリストを含むコメント コンテンツを更新します。

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

パラメーター

contentWithMentions
Excel.CommentRichContent

コメントの内容。 これには、特別に書式設定された文字列と、Excel で表示されるときに文字列に解析されるメンションの一覧が含まれます。

戻り値

void

注釈

[ API セット: ExcelApi 1.11 ]