Excel.CommentReplyCollection class
表示属于注释的注释回复对象的集合。
方法
| 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 用于枚举 ContentType.Plain，1.11 用于枚举 ContentType.Mention]
返回
注解
示例
// 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 用于字符串，1.11 用于 CommentRichContent 对象]
- contentType
-
"Plain" | "Mention"
可选。 批注中包含的内容的类型。 默认值为 enum ContentType.Plain。 [API 集：ExcelApi 1.10 用于枚举 ContentType.Plain，1.11 用于枚举 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”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.CommentReplyCollectionData;