Excel.CommentCollection class
ブックの一部であるコメント オブジェクトのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(cell |
指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 |
| add(cell |
指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 |
| get |
コレクションに含まれるコメントの数を取得します。 |
| get |
ID に基づいてコレクションからコメントを取得します。 |
| get |
位置に基づいてコレクションからコメントを取得します。 |
| get |
指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。 |
| get |
指定された応答が接続されているコメントを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(cellAddress, content, contentType)
指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
add(cellAddress: Range | string, content: string, contentType?: Excel.ContentType): Excel.Comment;パラメーター
- cellAddress
-
Excel.Range | string
コメントが追加されるセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
- content
-
string
コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです。 文字列はプレーン テキストに使用されます。
CommentRichContent オブジェクトを使用すると、メンションなどの他のコメント機能を使用できます。 [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object]
- contentType
- Excel.ContentType
省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plainです。 [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
戻り値
注釈
例
// 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");
// Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
sheet.comments.add("A2", "TODO: add data.");
await context.sync();
});
add(cellAddress, content, contentTypeString)
指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
add(cellAddress: Range | string, content: string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;パラメーター
- cellAddress
-
Excel.Range | string
コメントが追加されるセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
- content
-
string
コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです。 文字列はプレーン テキストに使用されます。
CommentRichContent オブジェクトを使用すると、メンションなどの他のコメント機能を使用できます。 [Api set: ExcelApi 1.10 for string, 1.11 for CommentRichContent object]
- contentTypeString
-
"Plain" | "Mention"
省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plainです。 [Api set: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
戻り値
注釈
getCount()
コレクションに含まれるコメントの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(commentId)
ID に基づいてコレクションからコメントを取得します。
getItem(commentId: string): Excel.Comment;パラメーター
- commentId
-
string
コメントの識別子。
戻り値
注釈
getItemAt(index)
位置に基づいてコレクションからコメントを取得します。
getItemAt(index: number): Excel.Comment;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
getItemByCell(cellAddress)
指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。
getItemByCell(cellAddress: Range | string): Excel.Comment;パラメーター
- cellAddress
-
Excel.Range | string
コメントがオンになっているセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
戻り値
注釈
getItemByReplyId(replyId)
指定された応答が接続されているコメントを取得します。
getItemByReplyId(replyId: string): Excel.Comment;パラメーター
- replyId
-
string
コメント応答の識別子。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.CommentCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.CommentCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.CommentCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.CommentCollectionData;戻り値
Office Add-ins