WPS WebOffice 开放平台WPS WebOffice 开放平台 | 开发文档

深色模式

评论(Comments) ​

评论对象集合

方法列表 ​

方法说明
HasComments()
是否有评论
GetComments()
获取全文评论
Add()
添加评论
DeleteComment()
根据位置信息删除指定评论
ShowComments()
控制评论显示与否
DeleteAllComments()
删除文档内的所有评论
ReplyComment()
回复评论
DeleteCommentById()
根据评论id删除评论
GetCommentReferenceText()
获取评论的引用文本
GoToComment()
跳转到评论
ModifyComment()
修改评论内容

HasComments() ​

ActiveDocument.HasComments()

是否有评论

语法 ​

表达式.ActiveDocument.HasComments()

表达式：文档类型应用对象

返回值 ​

返回 Boolean，为 true 表明有评论，否则没评论

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 是否有评论
  const hasComments = await app.ActiveDocument.HasComments()
  console.log(hasComments) // true|false
}

GetComments() ​

ActiveDocument.GetComments({ Offset, Limit })

获取全文评论

语法 ​

表达式.ActiveDocument.GetComments({ Offset, Limit })

表达式：文档类型应用对象

参数 ​

属性数据类型默认值必填说明
Offset
Number
是
起始位置
Limit
Number
是
限制条数

由于文字文档是流式排版, 在大文档时且 Limit - Offset 较大时，获取时间时间会比较长，建议加一个中间 loading 过渡效果。

返回值 ​

**Array.<Object>**

属性数据类型说明
auth
String
评论人
content
String
内容
date
Date
评论时间

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取全文评论
  const operatorsInfo = await app.ActiveDocument.GetComments({
    Offset: 0,
    Limit: 20
  })
  console.log(operatorsInfo)
}

Add() ​

添加评论

语法 ​

表达式.ActiveDocument.Comments.Add({ Range, Text })

表达式：文档类型应用对象。

参数 ​

属性类型默认值必填说明
+
Range
range {}
是
评论的文本区域
Text
string
是
评论内容

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 评论对象
  const comments = await app.ActiveDocument.Comments

  // 添加评论
  await comments.Add({
    Range: {
      Start: 0,
      End: 9
    },
    Text: 'WebOffice 评论'
  })
}

DeleteComment() ​

根据位置信息删除指定评论

可以通过 获取全文评论 来查看对应评论的位置信息

语法 ​

表达式.ActiveDocument.Comments.DeleteComment({ Start, Length })

表达式：文档类型应用对象。

参数 ​

Object object

属性数据类型默认值必填说明
Start
Number
是
评论的起始位置
Length
Number
是
评论文本的长度

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 评论对象
  const comments = await app.ActiveDocument.Comments

  // 添加评论
  await comments.Add({
    Range: {
      Start: 0,
      Length: 9
    },
    Text: 'WebOffice 评论'
  })

  // 删除评论
  await comments.DeleteComment({
    Start: 0,
    Length: 9
  })
}

ShowComments() ​

ActiveDocument.ActiveWindow.View.ShowComments

控制评论显示与否

语法 ​

`表达式.ActiveDocument.ActiveWindow.View.ShowComments = Boolean

表达式：文档类型应用对象

如果 Boolean 为 true，显示评论，否则隐藏评论

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 控制评论显示与否
  app.ActiveDocument.ActiveWindow.View.ShowComments = false
}

DeleteAllComments() ​

删除文档内的所有评论

语法 ​

表达式.ActiveDocument.DeleteAllComments()

表达式：文档类型应用对象

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 删除文档内的所有评论
  await app.ActiveDocument.DeleteAllComments()
}

ReplyComment() ​

警告

JSSDK: v1.1.14+、WebOffice v3.3.1+ 后已废弃查看详情。

回复评论

可以通过 获取全文评论 来查看对应评论的位置信息

语法 ​

表达式.ActiveDocument.Comments.ReplyComment({ CommentId, Text })

表达式：文档类型应用对象。

参数 ​

Object object

属性数据类型默认值必填说明
CommentId
String
是
所回复评论的 id，可通过 ActiveDocument.GetComments 获取全文评论（含 commentId）
Text
String
是
回复的内容

返回值 ​

WebOffice v4.2.1+ 支持返回评论数据

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 评论对象
  const comments = await app.ActiveDocument.Comments

  // 添加评论
  await comments.Add({
    Range: {
      Start: 0,
      End: 9
    },
    Text: 'WebOffice 评论'
  })

  // 获取第一条评论
  const commentList = await app.ActiveDocument.GetComments()
  const firstCommentId = commentList[0].commentId

  // 回复评论
  const result = await comments.ReplyComment({
    CommentId: firstCommentId,
    Text: '回复第一条评论'
  })
  console.log('result: ', result)
}

DeleteCommentById() ​

JSSDK: v1.1.19+ 支持

根据评论id删除评论

可以通过 获取全文评论 来查看对应评论的id信息

语法 ​

表达式.ActiveDocument.Comments.DeleteCommentById({ CommentId })

表达式：文档类型应用对象。

参数 ​

属性数据类型默认值必填说明
CommentId
String
是
评论id，可通过 ActiveDocument.GetComments 获取全文评论（含评论id）

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 评论对象
  const comments = await app.ActiveDocument.Comments;

  // 删除评论
  await comments.DeleteCommentById({
    CommentId: '1234567890'
  });
}

GetCommentReferenceText() ​

JSSDK: v1.1.19+ 支持

获取评论的引用文本

可以通过 获取全文评论 来查看对应评论的id信息

语法 ​

表达式.ActiveDocument.Comments.GetCommentReferenceText({ CommentId })

表达式：文档类型应用对象。

参数 ​

属性数据类型默认值必填说明
CommentId
String
是
评论id，可通过 ActiveDocument.GetComments 获取全文评论（含评论id）

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 评论对象
  const comments = await app.ActiveDocument.Comments;

  // 获取评论引用文本
  await comments.GetCommentReferenceText({
    CommentId: '1234567890'
  });
}

GoToComment() ​

JSSDK: v1.1.19+ 支持

跳转到评论

可以通过 获取全文评论 来查看对应评论的id信息

语法 ​

表达式.ActiveDocument.Comments.GoToComment({ CommentId })

表达式：文档类型应用对象。

参数 ​

属性数据类型默认值必填说明
CommentId
String
是
评论id，可通过 ActiveDocument.GetComments 获取全文评论（含评论id）

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 评论对象
  const comments = await app.ActiveDocument.Comments;

  // 跳转到评论
  await comments.GoToComment({
    CommentId: '1234567890'
  });
}

ModifyComment() ​

JSSDK: v1.1.19+ 支持

修改评论内容

可以通过 获取全文评论 来查看对应评论的id信息

语法 ​

表达式.ActiveDocument.Comments.ModifyComment({ CommentId, Text })

表达式：文档类型应用对象。

参数 ​

属性数据类型默认值必填说明
CommentId
String
是
评论id，可通过 ActiveDocument.GetComments 获取全文评论（含评论id）
Text
String
是
新的评论内容

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 评论对象
  const comments = await app.ActiveDocument.Comments;

  // 修改评论内容
  await comments.ModifyComment({
    CommentId: '1234567890',
    Text: '新的评论内容'
  });
}