Excel.Comment class

表示工作簿中的注释。

扩展

注解

[ API 集:ExcelApi 1.10 ]

属性

authorEmail

获取批注作者的电子邮件。

authorName

获取批注作者的姓名。

content

批注的内容。 字符串为纯文本。

contentType

获取批注的内容类型。

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

creationDate

获取批注的创建时间。 null如果注释是从笔记转换的,则返回 ,因为注释没有创建日期。

id

指定注释标识符。

mentions

获取 (实体,例如注释中提到的人员) 。

replies

表示与批注关联的回复对象的集合。

resolved

注释线程状态。 值 true 表示已解析注释线程。

richContent

获取丰富的批注内容 (例如注释) 中的提及。 此字符串不应显示给最终用户。 外接程序应仅使用此来分析丰富的注释内容。

方法

assignTask(assignee)

将附加到批注的任务作为代理人分配给给定用户。 如果没有任务,则会创建一个任务。

delete()

删除批注和所有已连接的回复。

getLocation()

获取此注释所在的单元格。

getTask()

获取与此注释关联的任务。 如果注释线程没有任务, ItemNotFound 则会引发异常。

getTaskOrNullObject()

获取与此注释关联的任务。 如果注释线程没有任务,则此方法返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.Comment对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.CommentData) ,其中包含原始对象中任何已加载子属性的浅表副本。

updateMentions(contentWithMentions)

使用特殊格式的字符串和提及列表汇报注释内容。

属性详细信息

authorEmail

获取批注作者的电子邮件。

readonly authorEmail: string;

属性值

string

注解

[ API 集:ExcelApi 1.10 ]

authorName

获取批注作者的姓名。

readonly authorName: string;

属性值

string

注解

[ API 集:ExcelApi 1.10 ]

content

批注的内容。 字符串为纯文本。

content: string;

属性值

string

注解

[ API 集:ExcelApi 1.10 ]

示例

// 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");
    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"

注解

[ API 集:ExcelApi 1.12 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

creationDate

获取批注的创建时间。 null如果注释是从笔记转换的,则返回 ,因为注释没有创建日期。

readonly creationDate: Date;

属性值

Date

注解

[ API 集:ExcelApi 1.10 ]

id

指定注释标识符。

readonly id: string;

属性值

string

注解

[ API 集:ExcelApi 1.10 ]

mentions

获取 (实体,例如注释中提到的人员) 。

readonly mentions: Excel.CommentMention[];

属性值

注解

[ API 集:ExcelApi 1.11 ]

replies

表示与批注关联的回复对象的集合。

readonly replies: Excel.CommentReplyCollection;

属性值

注解

[ API 集:ExcelApi 1.10 ]

resolved

注释线程状态。 值 true 表示已解析注释线程。

resolved: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.11 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/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

注解

[ API 集:ExcelApi 1.11 ]

方法详细信息

assignTask(assignee)

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将附加到批注的任务作为代理人分配给给定用户。 如果没有任务,则会创建一个任务。

assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;

参数

assignee
Excel.EmailIdentity

被分配者的用户标识信息。

返回

注解

[ API 集:ExcelApi BETA (仅预览版) ]

delete()

删除批注和所有已连接的回复。

delete(): void;

返回

void

注解

[ API 集:ExcelApi 1.10 ]

示例

// 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) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

getLocation()

获取此注释所在的单元格。

getLocation(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.10 ]

getTask()

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取与此注释关联的任务。 如果注释线程没有任务, ItemNotFound 则会引发异常。

getTask(): Excel.DocumentTask;

返回

注解

[ API 集:ExcelApi BETA (仅预览版) ]

getTaskOrNullObject()

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取与此注释关联的任务。 如果注释线程没有任务,则此方法返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

getTaskOrNullObject(): Excel.DocumentTask;

返回

注解

[ API 集:ExcelApi BETA (仅预览版) ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;

参数

options
Excel.Interfaces.CommentLoadOptions

提供要加载对象的属性的选项。

返回

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-comment/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)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Excel.Comment): void;

参数

properties
Excel.Comment

返回

void

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

注解

[ API 集:ExcelApi 1.11 ]