Share via

Word.CommentReply class

  • 参考
包:
word

表示文档中的批注答复。

Extends
OfficeExtension.ClientObject

注解

[ API 集：WordApi 1.4 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
  const text = $("#reply-text")
    .val()
    .toString();
  const comments = context.document.getSelection().getComments();
  comments.load("items");
  await context.sync();

  const firstActiveComment = comments.items.find((item) => item.resolved !== true);
  if (firstActiveComment) {
    const reply = firstActiveComment.reply(text);
    console.log("Reply added");
  } else {
    console.log("No active comment was found in the selection so couldn't reply.");
  }
});

属性

authorEmail

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

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

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

指定 commentReply 的内容范围。
context

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

获取批注答复的创建日期。
id

获取批注回复的 ID。
parentComment

获取此答复的父批注。

方法

delete()

删除批注回复。
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传递给它的 对象的 方法。) 而原始Word。CommentReply 对象是一个 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.CommentReplyData) ，该对象包含原始对象中任何已加载子属性的浅表副本。
track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

属性详细信息

authorEmail

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

readonly authorEmail: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

authorName

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

readonly authorName: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

content

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

content: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

contentRange

指定 commentReply 的内容范围。

contentRange: Word.CommentContentRange;

属性值

Word.CommentContentRange

注解

[ API 集：WordApi 1.4 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

creationDate

获取批注答复的创建日期。

readonly creationDate: Date;

属性值

Date

注解

[ API 集：WordApi 1.4 ]

id

获取批注回复的 ID。

readonly id: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

parentComment

获取此答复的父批注。

readonly parentComment: Word.Comment;

属性值

Word.Comment

注解

[ API 集：WordApi 1.4 ]

方法详细信息

delete()

删除批注回复。

delete(): void;

返回

void

注解

[ API 集：WordApi 1.4 ]

load(options)

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

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

参数

options
Word.Interfaces.CommentReplyLoadOptions

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

返回

Word.CommentReply

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Word.CommentReply

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Word.CommentReply

set(properties, options)

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

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

参数

properties
Word.Interfaces.CommentReplyUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Word.CommentReply): void;

参数

properties
Word.CommentReply

返回

void

toJSON()

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

toJSON(): Word.Interfaces.CommentReplyData;

返回

Word.Interfaces.CommentReplyData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.CommentReply;

返回

Word.CommentReply

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.CommentReply;

返回

Word.CommentReply