Excel.Comment class

注意

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

ブック内のセルのコメントオブジェクトを表します。Represents a cell comment object in the workbook.

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

Extends

プロパティ

authorEmail

コメント作成者のメール アドレスを取得します。Gets the email of the comment's author.

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

authorName

コメント作成者の名前を取得します。Gets the name of the comment's author.

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

content

コメントの内容を取得または設定します。Gets or sets the comment's content. 文字列はテキスト形式です。The string is plain text.

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

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

creationDate

コメントの作成日時を取得します。Gets the creation time of the comment. コメントがメモから変換されている場合、コメントには作成日時がないため、null が返されます。Returns null if the comment was converted from a note, since the comment does not have a creation date.

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

id

コメント ID を表します。Represents the comment identifier. 読み取り専用です。Read-only.

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

replies

コメントに関連付けられている返信オブジェクトのコレクションを表します。Represents a collection of reply objects associated with the comment. 読み取り専用です。Read-only.

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

メソッド

delete()

コメント スレッドを削除します。Deletes the comment thread.

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

getLocation()

このコメントが配置されているセルを取得します。Gets the cell where this comment is located.

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

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel Comment オブジェクトは API オブジェクトであるのに対しtoJSONて、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CommentData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

authorEmail

注意

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

コメント作成者のメール アドレスを取得します。Gets the email of the comment's author.

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

readonly authorEmail: string;

プロパティ値

string

authorName

注意

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

コメント作成者の名前を取得します。Gets the name of the comment's author.

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

readonly authorName: string;

プロパティ値

string

content

注意

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

コメントの内容を取得または設定します。Gets or sets the comment's content. 文字列はテキスト形式です。The string is plain text.

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

content: string;

プロパティ値

string

Examples

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

context

注意

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

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

creationDate

注意

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

コメントの作成日時を取得します。Gets the creation time of the comment. コメントがメモから変換されている場合、コメントには作成日時がないため、null が返されます。Returns null if the comment was converted from a note, since the comment does not have a creation date.

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

readonly creationDate: Date;

プロパティ値

Date

id

注意

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

コメント ID を表します。Represents the comment identifier. 読み取り専用です。Read-only.

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

readonly id: string;

プロパティ値

string

replies

注意

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

コメントに関連付けられている返信オブジェクトのコレクションを表します。Represents a collection of reply objects associated with the comment. 読み取り専用です。Read-only.

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

readonly replies: Excel.CommentReplyCollection;

プロパティ値

メソッドの詳細

delete()

注意

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

コメント スレッドを削除します。Deletes the comment thread.

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

delete(): void;

戻り値

void

Examples

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

getLocation()

注意

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

このコメントが配置されているセルを取得します。Gets the cell where this comment is located.

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

getLocation(): Excel.Range;

戻り値

load(option)

注意

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

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Comment-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Comment - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Comment-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Comment - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Comment-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Comment - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

注意

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

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

注意

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

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

Examples

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();
});

set(properties, options)

注意

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

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.CommentUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Comment): void

set(properties)

注意

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

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Comment): void;

パラメーター

properties
Excel.Comment

戻り値

void

toJSON()

注意

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

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel Comment オブジェクトは API オブジェクトであるのに対しtoJSONて、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CommentData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.CommentData;

戻り値