Excel.CommentReplyCollection class
コメントの一部であるコメント応答オブジェクトのコレクションを表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(content, content |
コメントに対するコメント返信を作成します。 |
| add(content, content |
コメントに対するコメント返信を作成します。 |
| get |
コレクションのコメント返信数を取得します。 |
| get |
その ID で識別されるコメント返信を返します。 |
| get |
コレクション内の位置に基づいてコメント返信を取得します。 |
| get |
その ID で識別されるコメント返信を返します。 コメント応答オブジェクトが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(content, contentType)
コメントに対するコメント返信を作成します。
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;パラメーター
- content
-
Excel.CommentRichContent | string
コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです (メンションのあるコメントの場合など)。 [API セット: 文字列の場合は ExcelApi 1.10、CommentRichContent オブジェクトの場合は 1.11]
- contentType
- Excel.ContentType
省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plain です。 [API セット: 列挙型 ContentType.Plain の場合は ExcelApi 1.10、列挙型 ContentType.Mention の場合は 1.11]
返品
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml
await Excel.run(async (context) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
add(content, contentType)
コメントに対するコメント返信を作成します。
add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply;パラメーター
- content
-
Excel.CommentRichContent | string
コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです (メンションのあるコメントの場合など)。 [API セット: 文字列の場合は ExcelApi 1.10、CommentRichContent オブジェクトの場合は 1.11]
- contentType
-
"Plain" | "Mention"
省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plain です。 [API セット: 列挙型 ContentType.Plain の場合は ExcelApi 1.10、列挙型 ContentType.Mention の場合は 1.11]
返品
注釈
getCount()
コレクションのコメント返信数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
getItem(commentReplyId)
その ID で識別されるコメント返信を返します。
getItem(commentReplyId: string): Excel.CommentReply;パラメーター
- commentReplyId
-
string
コメント応答の識別子。
返品
注釈
getItemAt(index)
コレクション内の位置に基づいてコメント返信を取得します。
getItemAt(index: number): Excel.CommentReply;パラメーター
- index
-
number
取得するコメント応答のインデックス値。 コレクションでは、0 から始まるインデックス作成が使用されます。
返品
注釈
getItemOrNullObject(commentReplyId)
その ID で識別されるコメント返信を返します。 コメント応答オブジェクトが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(commentReplyId: string): Excel.CommentReply;パラメーター
- commentReplyId
-
string
コメント応答の識別子。
返品
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.CommentReplyCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentReplyCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.CommentReplyCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.CommentReplyCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.CommentReplyCollectionData;