Excel.CommentReplyCollection class

注意

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

コメントの一部であるコメントの返信オブジェクトのコレクションを表します。Represents a collection of comment reply objects that are part of the comment.

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

Extends

プロパティ

context

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

items

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

メソッド

add(content, contentType)

コメントのコメント返信を作成します。Creates a comment reply for comment.

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

add(content, contentTypeString)

コメントのコメント返信を作成します。Creates a comment reply for comment.

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

getCount()

コレクションのコメント返信数を取得します。Gets the number of comment replies in the collection.

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

getItem(commentReplyId)

その ID で識別されるコメント返信を返します。Returns a comment reply identified by its ID. 読み取り専用です。Read-only.

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

getItemAt(index)

コレクション内の位置に基づいてコメント返信を取得します。Gets a comment reply based on its position in the collection.

[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(option)
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.CommentReplyCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CommentReplyCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CommentReplyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentReplyCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

プロパティの詳細

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

items

注意

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

このコレクション内に読み込まれた子アイテムを取得します。Gets the loaded child items in this collection.

readonly items: Excel.CommentReply[];

プロパティ値

Excel.CommentReply[]

メソッドの詳細

add(content, contentType)

注意

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

コメントのコメント返信を作成します。Creates a comment reply for comment.

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

add(content: string, contentType?: Excel.ContentType): Excel.CommentReply;

パラメーター

content
string

コメントの内容。The comment content.

contentType
Excel.ContentType

省略可能。Optional. コメントの内容の種類Type of the comment content

戻り値

Examples

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemAt(0);
    comment.replies.add("Do I have to?");
    await context.sync();
});

add(content, contentTypeString)

注意

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

コメントのコメント返信を作成します。Creates a comment reply for comment.

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

add(content: string, contentTypeString?: "Plain"): Excel.CommentReply;

パラメーター

content
string

コメントの内容。The comment content.

contentTypeString
"Plain"

省略可能。Optional. コメントの内容の種類Type of the comment content

戻り値

getCount()

注意

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

コレクションのコメント返信数を取得します。Gets the number of comment replies in the collection.

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(commentReplyId)

注意

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

その ID で識別されるコメント返信を返します。Returns a comment reply identified by its ID. 読み取り専用です。Read-only.

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

getItem(commentReplyId: string): Excel.CommentReply;

パラメーター

commentReplyId
string

コメント応答の識別子。The identifier for the comment reply.

戻り値

getItemAt(index)

注意

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

コレクション内の位置に基づいてコメント返信を取得します。Gets a comment reply based on its position in the collection.

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

getItemAt(index: number): Excel.CommentReply;

パラメーター

index
number

取得するオブジェクトのインデックス値。Index value of the object to be retrieved. 0 を起点とする番号になります。Zero-indexed.

戻り値

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.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;

パラメーター

option
Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

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

load(option?: string | string[]): Excel.CommentReplyCollection-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.CommentReplyCollection - 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.CommentReplyCollection-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.CommentReplyCollection - 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.CommentReplyCollection-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.CommentReplyCollection - 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.CommentReplyCollection;

パラメーター

propertyNames
string | string[]

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

戻り値

load(option)

注意

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

load(option?: OfficeExtension.LoadOption): Excel.CommentReplyCollection;

パラメーター

戻り値

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.CommentReplyCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CommentReplyCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CommentReplyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentReplyCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "items" 配列を含みます。) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.CommentReplyCollectionData;

戻り値