Excel.CommentCollection class

注意

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

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

[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, cellAddress, contentType)

指定したセルに、指定されたコンテンツを含む新しいコメント (コメントスレッド) を作成します。Creates a new comment (comment thread) with the given content on the given cell. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

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

add(content, cellAddress, contentTypeString)

指定したセルに、指定されたコンテンツを含む新しいコメント (コメントスレッド) を作成します。Creates a new comment (comment thread) with the given content on the given cell. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

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

getCount()

コレクションに含まれるコメントの数を取得します。Gets the number of comments in the collection.

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

getItem(commentId)

ID に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its ID. 読み取り専用です。Read-only.

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

getItemAt(index)

位置に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its position.

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

getItemByCell(cellAddress)

指定したセルからコメントを取得します。Gets the comment from the specified cell.

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

getItemByReplyId(replyId)

コレクション内のその返信 ID に関連付けられているコメントを取得します。Gets a comment related to its reply ID 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.CommentCollectionのオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.CommentCollectionData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.CommentCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.CommentCollectionData) を使用して、コレクションのアイテムから読み込まれたプロパティの浅いコピーを持つ "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.Comment[];

プロパティ値

Excel.Comment[]

メソッドの詳細

add(content, cellAddress, contentType)

注意

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

指定したセルに、指定されたコンテンツを含む新しいコメント (コメントスレッド) を作成します。Creates a new comment (comment thread) with the given content on the given cell. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

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

add(content: string, cellAddress: Range | string, contentType?: Excel.ContentType): Excel.Comment;

パラメーター

content
string

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

cellAddress
Range | string

コメントを追加するセルを指定します。The cell to which the comment is added. Range オブジェクトまたは文字列を指定できます。This can be a Range object or a string. 文字列型 (string) の場合は、シート名を含む完全な住所が含まれている必要があります。If it's a string, it must contain the full address, including the sheet name. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

contentType
Excel.ContentType

省略可能。Optional. コメントコンテンツの種類The type of the comment content

戻り値

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");

    // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
    sheet.comments.add("TODO: add data.", "A2");
    await context.sync();
});

add(content, cellAddress, contentTypeString)

注意

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

指定したセルに、指定されたコンテンツを含む新しいコメント (コメントスレッド) を作成します。Creates a new comment (comment thread) with the given content on the given cell. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

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

add(content: string, cellAddress: Range | string, contentTypeString?: "Plain"): Excel.Comment;

パラメーター

content
string

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

cellAddress
Range | string

コメントを追加するセルを指定します。The cell to which the comment is added. Range オブジェクトまたは文字列を指定できます。This can be a Range object or a string. 文字列型 (string) の場合は、シート名を含む完全な住所が含まれている必要があります。If it's a string, it must contain the full address, including the sheet name. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

contentTypeString
"Plain"

省略可能。Optional. コメントコンテンツの種類The type of the comment content

戻り値

getCount()

注意

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

コレクションに含まれるコメントの数を取得します。Gets the number of comments in the collection.

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

getItem(commentId)

注意

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

ID に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its ID. 読み取り専用です。Read-only.

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

getItem(commentId: string): Excel.Comment;

パラメーター

commentId
string

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

戻り値

getItemAt(index)

注意

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

位置に基づいてコレクションからコメントを取得します。Gets a comment from the collection based on its position.

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

getItemAt(index: number): Excel.Comment;

パラメーター

index
number

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

戻り値

getItemByCell(cellAddress)

注意

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

指定したセルからコメントを取得します。Gets the comment from the specified cell.

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

getItemByCell(cellAddress: Range | string): Excel.Comment;

パラメーター

cellAddress
Range | string

コメントがあるセルを指定します。The cell which the comment is on. Range オブジェクトまたは文字列を指定できます。This can be a Range object or a string. 文字列型 (string) の場合は、シート名を含む完全な住所が含まれている必要があります。If it's a string, it must contain the full address, including the sheet name. 指定InvalidArgumentした範囲が1つのセルより大きい場合は、エラーがスローされます。An InvalidArgument error is thrown if the provided range is larger than one cell.

戻り値

getItemByReplyId(replyId)

注意

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

コレクション内のその返信 ID に関連付けられているコメントを取得します。Gets a comment related to its reply ID in the collection.

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

getItemByReplyId(replyId: string): Excel.Comment;

パラメーター

replyId
string

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

戻り値

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

パラメーター

option
Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

戻り値

注釈

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

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

パラメーター

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.CommentCollection;

パラメーター

戻り値

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

toJSON(): Excel.Interfaces.CommentCollectionData;

戻り値