Word.Comment class

参考

包:: word

表示文档中的注释。

Extends: OfficeExtension.ClientObject

注解

属性

authorEmail	获取批注作者的电子邮件。
authorName	获取批注作者的姓名。
content	将注释的内容指定为纯文本。
contentRange	指定注释的内容范围。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
creationDate	获取批注的创建日期。
id	获取注释的 ID。
replies	获取与注释关联的回复对象的集合。
resolved	指定注释线程的状态。将设置为 true 可解析注释线程。获取值为 true 意味着注释线程已解析。

方法

delete()	删除批注及其答复。
getRange()	获取注释所在的main文档中的区域。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
reply(replyText)	将新答复添加到注释线程的末尾。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，反过来又调用`toJSON`传递给它的对象的方法。) 而原始Word。Comment 对象是一个 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.CommentData`) ，其中包含原始对象中加载的任何子属性的浅表副本。
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 ]

示例

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

// Edits the first comment in the selected content.
await Word.run(async (context) => {
  const text = $("#edit-comment-text")
    .val()
    .toString();
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.content = text;

  // Load object for display in Script Lab console.
  comment.load();
  await context.sync();

  console.log("Comment content changed:");
  console.log(comment);
});

contentRange

指定注释的内容范围。

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 ]

replies

获取与注释关联的回复对象的集合。

readonly replies: Word.CommentReplyCollection;

属性值

Word.CommentReplyCollection

注解

[ API 集：WordApi 1.4 ]

resolved

指定注释线程的状态。将设置为 true 可解析注释线程。获取值为 true 意味着注释线程已解析。

resolved: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.4 ]

示例

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

// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.load("resolved");
  await context.sync();

  // Toggle resolved status.
  // If the comment is active, set as resolved.
  // If it's resolved, set resolved to false.
  const toggleResolved: boolean = comment.resolved;
  comment.resolved = !toggleResolved;
  comment.load();
  await context.sync();

  console.log(`Comment Resolved status: ${comment.resolved}`);
  console.log(comment);
});

方法详细信息

delete()

删除批注及其答复。

delete(): void;

void

注解

[ API 集：WordApi 1.4 ]

示例

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

// Deletes the first comment in the selected content.
await Word.run(async (context) => {
  context.document
    .getSelection()
    .getComments()
    .getFirst()
    .delete();
  await context.sync();

  console.log("Comment deleted");
});

getRange()

获取注释所在的main文档中的区域。

getRange(): Word.Range;

Word.Range

注解

[ API 集：WordApi 1.4 ]

示例

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

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const range = context.document
    .getSelection()
    .getComments()
    .getFirst()
    .getRange();
  range.load("text");
  await context.sync();

  console.log(`Comment location: ${range.text}`);
});

load(options)

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

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

参数

options: Word.Interfaces.CommentLoadOptions

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

Word.Comment

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Word.Comment

load(propertyNamesAndPaths)

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

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

参数

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

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

Word.Comment

reply(replyText)

将新答复添加到注释线程的末尾。

reply(replyText: string): Word.CommentReply;

参数

replyText: string

必需。回复文本。

Word.CommentReply

注解

[ 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.");
  }
});

set(properties, options)

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

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

参数

properties: Word.Interfaces.CommentUpdateData

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

options: OfficeExtension.UpdateOptions

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

void

set(properties)

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

set(properties: Word.Comment): void;

参数

properties: Word.Comment

void

toJSON()

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

toJSON(): Word.Interfaces.CommentData;

Word.Interfaces.CommentData

track()

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

track(): Word.Comment;

Word.Comment

untrack()

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

untrack(): Word.Comment;

Word.Comment

Word.Comment class

注解

属性

方法

属性详细信息

authorEmail

属性值

注解

authorName

属性值

注解

content

属性值

注解

示例

contentRange

属性值

注解

context

属性值

creationDate

属性值

注解

id

属性值

注解

replies

属性值

注解

resolved

属性值

注解

示例

方法详细信息

delete()

返回

注解

示例

getRange()

返回

注解

示例

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

reply(replyText)

参数

返回

注解

示例

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源