金山文档开放平台

主题

回到顶部
本页内容

文字组件评论操作相关 API

是否有评论

ActiveDocument.HasComments()

是否有评论

语法

表达式.ActiveDocument.HasComments()

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

返回值

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

示例 

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

  const app = instance.Application

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

获取全文评论

ActiveDocument.GetComments({ Offset, Limit })

获取全文评论

语法

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

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

参数

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

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

返回值

**Array.<Object>**

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

示例 

//@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)
}

控制评论显示与否

ActiveDocument.ActiveWindow.View.ShowComments

控制评论显示与否

语法

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

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

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

示例 

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

  const app = instance.Application

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

删除所有评论

ActiveDocument.DeleteAllComments()

删除文档内的所有评论

语法

表达式.ActiveDocument.DeleteAllComments()

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

示例 

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

  const app = instance.Application

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