金山文档开放平台主题
评论
Comments
JSSDK: v1.1.10+、WebOffice v2.3.1+ 支持
评论对象
语法
表达式.ActiveDocument.Comments
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 评论对象
const Comments = await app.ActiveDocument.Comments
}
Add()
JSSDK: v1.1.10+、WebOffice v2.3.1+ 支持
添加评论
语法
表达式.ActiveDocument.Comments.Add({ Range, Text })
表达式：文档类型应用对象。
参数
Object object
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Range | Object | 是 | 评论的文本区域 | |
Text | String | 是 | 评论内容 |
Range 说明
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Start | Number | 是 | 设置评论的起点 | |
End | Number | 是 | 设置评论的终点 |
示例
//@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()
JSSDK: v1.1.10+、WebOffice v2.3.1+ 支持
根据位置信息删除指定评论
可以通过 获取全文评论 来查看对应评论的位置信息
语法
表达式.ActiveDocument.Comments.DeleteComment({ Start, Length })
表达式：文档类型应用对象。
参数
Object object
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
Start | Number | 是 | 评论的起始位置 | |
Length | Number | 是 | 评论文本的长度 |
示例
//@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 评论'
})
// 删除评论
await comments.DeleteComment({
Start: 0,
Length: 9
})
}
ReplyComment()
JSSDK: v1.1.14+、WebOffice v3.4.1+ 支持
回复评论
可以通过 获取全文评论 来查看对应评论的位置信息
语法
表达式.ActiveDocument.Comments.ReplyComment({ CommentId, Text })
表达式：文档类型应用对象。
参数
Object object
| 属性 | 数据类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
CommentId | String | 是 | 所回复评论的 id，可通过 ActiveDocument.GetComments 获取全文评论（含 commentId） | |
Text | String | 是 | 回复的内容 |
返回值
WebOffice v4.2.1+ 支持返回评论数据
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 评论对象
const comments = await app.ActiveDocument.Comments
// 添加评论
await comments.Add({
Range: {
CommentId: 0,
End: 9
},
Text: 'WebOffice 评论'
})
// 获取第一条评论
const comments = await app.ActiveDocument.GetComments()
const firstCommentId = comments[0].commentId
// 回复评论
const result = await comments.ReplyComment({
CommentId: firstCommentId,
Text: '回复第一条评论'
})
console.log('result: ', result)
}