Excel.CommentReplyCollection class
表示注释答复对象的集合，这些对象属于批注的一部分。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(content, content |
为批注创建批注回复。 |
| add(content, content |
为批注创建批注回复。 |
| get |
获取集合中的批注回复数量。 |
| get |
返回由其 ID 标识的批注回复。 |
| get |
根据其在集合中的位置获取批注回复。 |
| get |
返回由其 ID 标识的批注回复。 如果注释回复对象不存在，则此方法返回一个对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
add(content, contentType)
为批注创建批注回复。
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;参数
- content
-
Excel.CommentRichContent | string
批注的内容。 这可以是字符串或 CommentRichContent 对象 (例如，对于带有提及) 的注释。 [Api 集：ExcelApi 1.10 字符串，1.11 用于 CommentRichContent 对象]
- contentType
- Excel.ContentType
可选。 批注中包含的内容类型。 默认值为 enum ContentType.Plain。 [Api 集：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-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, contentTypeString)
为批注创建批注回复。
add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;参数
- content
-
Excel.CommentRichContent | string
批注的内容。 这可以是字符串或 CommentRichContent 对象 (例如，对于带有提及) 的注释。 [Api 集：ExcelApi 1.10 字符串，1.11 用于 CommentRichContent 对象]
- contentTypeString
-
"Plain" | "Mention"
可选。 批注中包含的内容类型。 默认值为 enum ContentType.Plain。 [Api 集：ExcelApi 1.10 for Enum ContentType.Plain，1.11 for Enum ContentType.Mention]
返回
注解
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
要检索的注释答复的索引值。 集合使用从零开始的索引。
返回
注解
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()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.CommentReplyCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.CommentReplyCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.CommentReplyCollectionData;