Excel.Comment class
表示工作簿中的注释。
注解
使用方
属性
| author |
获取批注作者的电子邮件。 |
| author |
获取批注作者的姓名。 |
| content | 评论的内容。 字符串是纯文本。 |
| content |
获取注释的内容类型。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| creation |
获取批注的创建时间。 如果注释是从注释转换而来的，则返回 |
| id | 指定注释标识符。 |
| mentions | 获取实体 (例如，注释中提到的人) 。 |
| replies | 表示与批注关联的回复对象的集合。 |
| resolved | 批注线程状态。 值为 表示 |
| rich |
获取丰富的批注内容 (例如，批注) 中的提及。 此字符串不应向最终用户显示。 加载项应仅使用它来分析丰富的注释内容。 |
方法
| assign |
将附加到注释的任务分配给指定用户作为被分配人。 如果没有任务，则会创建一个。 |
| delete() | 删除评论和所有已连接的回复。 |
| get |
获取此注释所在的单元格。 |
| get |
获取与此注释关联的任务。 如果没有批注线程的任务， |
| get |
获取与此注释关联的任务。 如果注释线程没有任务，则此方法返回其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| update |
使用特殊格式的字符串和提及列表汇报批注内容。 |
属性详细信息
authorEmail
authorName
content
评论的内容。 字符串是纯文本。
content: string;属性值
string
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.content = "PLEASE add headers here.";
await context.sync();
});
contentType
获取注释的内容类型。
readonly contentType: Excel.ContentType | "Plain" | "Mention";属性值
Excel.ContentType | "Plain" | "Mention"
注解
context
creationDate
获取批注的创建时间。 如果注释是从注释转换而来的，则返回 null ，因为注释没有创建日期。
readonly creationDate: Date;属性值
Date
注解
id
mentions
获取实体 (例如，注释中提到的人) 。
readonly mentions: Excel.CommentMention[];属性值
注解
replies
表示与批注关联的回复对象的集合。
readonly replies: Excel.CommentReplyCollection;属性值
注解
resolved
批注线程状态。 值为 表示 true 批注线程已解析。
resolved: boolean;属性值
boolean
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-resolution.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
sheet.comments.getItemAt(0).resolved = true;
await context.sync();
});
richContent
获取丰富的批注内容 (例如，批注) 中的提及。 此字符串不应向最终用户显示。 加载项应仅使用它来分析丰富的注释内容。
readonly richContent: string;属性值
string
注解
方法详细信息
assignTask(assignee)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将附加到注释的任务分配给指定用户作为被分配人。 如果没有任务，则会创建一个。
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;参数
- assignee
- Excel.EmailIdentity
被分配人的用户标识信息。
返回
注解
delete()
删除评论和所有已连接的回复。
delete(): void;返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml
await Excel.run(async (context) => {
context.workbook.comments.getItemByCell("Comments!A2").delete();
await context.sync();
});
getLocation()
getTask()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取与此注释关联的任务。 如果没有批注线程的任务， ItemNotFound 则会引发异常。
getTask(): Excel.DocumentTask;返回
注解
getTaskOrNullObject()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取与此注释关联的任务。 如果注释线程没有任务，则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getTaskOrNullObject(): Excel.DocumentTask;返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.Comment;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml
await Excel.run(async (context) => {
const comment = context.workbook.comments.getItemByCell("Comments!A2");
comment.load(["authorEmail", "authorName", "creationDate"]);
await context.sync();
console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
await context.sync();
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Comment;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.CommentUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.Comment 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.CommentData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.CommentData;返回
updateMentions(contentWithMentions)
使用特殊格式的字符串和提及列表汇报批注内容。
updateMentions(contentWithMentions: Excel.CommentRichContent): void;参数
- contentWithMentions
- Excel.CommentRichContent
注释的内容。 它包含一个特殊格式的字符串和一个提及列表，当 Excel 显示时，这些提及将被解析为字符串。
返回
void