Excel.CommentReply class

表示工作簿中的批注答复。

扩展

注解

[ API 集:ExcelApi 1.10 ]

属性

authorEmail

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

authorName

获取批注回复作者的姓名。

content

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

context

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

creationDate

获取批注回复的创建时间。

id

指定批注回复标识符。

方法

delete()

删除批注回复。

getLocation()

获取此批注回复所在的单元格。

getParentComment()

获取此答复的父批注。

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.CommentReply对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.CommentReplyData) ,其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

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-comments-and-notes/comment-replies.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    const reply = comment.replies.getItemAt(0);
    reply.load("content");
    // Sync to load the content of the comment reply.
    await context.sync();

    // Append "Please!" to the end of the comment reply.
    reply.content += " Please!";
    await context.sync();
});

context

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

context: RequestContext;

属性值

creationDate

获取批注回复的创建时间。

readonly creationDate: Date;

属性值

Date

注解

[ API 集:ExcelApi 1.10 ]

id

指定批注回复标识符。

readonly id: string;

属性值

string

注解

[ API 集:ExcelApi 1.10 ]

方法详细信息

delete()

删除批注回复。

delete(): void;

返回

void

注解

[ API 集:ExcelApi 1.10 ]

示例

// 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) => {
    // Remove the first comment reply from this worksheet's first comment.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.replies.getItemAt(0).delete();
    await context.sync();
});

getLocation()

获取此批注回复所在的单元格。

getLocation(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.10 ]

getParentComment()

获取此答复的父批注。

getParentComment(): Excel.Comment;

返回

注解

[ API 集:ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;

参数

options
Excel.Interfaces.CommentReplyLoadOptions

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

返回

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.CommentReply;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.CommentReply;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

set(properties, options)

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

set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.CommentReplyUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

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

set(properties: Excel.CommentReply): void;

参数

properties
Excel.CommentReply

返回

void

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.CommentReply对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.CommentReplyData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.CommentReplyData;

返回