金山文档开放平台主题
文字组件修订操作相关 API
获取修订对象
ActiveDocument.Revisions
修订对象
语法
表达式.ActiveDocument.Revisions
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
}
切换修订模式
ActiveDocument.TrackRevisions
编辑与修订模式切换
语法
表达式.ActiveDocument.TrackRevisions = Boolean
表达式：文档类型应用对象。
如果 Boolean 值为 true，则表明切换到修订模式，否则为编辑模式。
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 将当前文档的编辑状态切换成修订模式
app.ActiveDocument.TrackRevisions = true
}
获取全文修订
ActiveDocument.Revisions.Json()
获取全文修订内容
语法
表达式.ActiveDocument.Revisions.Json()
表达式：文档类型应用对象。
返回值
将以 Array.<Object> 的形式返回全部修订内容，例如 [{ user, ... }]，具体返回情况如下：
| 属性 | 数据类型 | 说明 |
|---|---|---|
user | String | 用户名 |
leader | String | 修订批注 |
begin | Number | 修订开始位置 |
end | Number | 修订结束位置 |
content | String | 修订后内容 |
type | String | 修订类型 |
date | Number | 时间戳 |
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取全文修订内容
const revisionData = await revisions.Json()
console.log(revisionData)
}
全文修订数量
ActiveDocument.Revisions.Count
接受对指定文档的所有修订
示例
//@file=base.pptx
async function example() {
await instance.ready()
const app = instance.Application
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取全文修订数量
const count = await revisions.Count
console.log(count)
}
接受所有修订
ActiveDocument.Revisions.AcceptAll()
接受对指定文档的所有修订
示例
//@file=base.pptx
async function example() {
await instance.ready()
const app = instance.Application
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 接受对指定文档的所有修订
await revisions.AcceptAll()
}
拒绝所有修订
ActiveDocument.Revisions.RejectAll()
拒绝所有修订
语法
表达式.ActiveDocument.Revisions.RejectAll()
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
const app = instance.Application
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 拒绝对指定文档的所有修订
await revisions.RejectAll()
}
获取单个修订对象
ActiveDocument.Revisions.Item(Index)
单个修订对象
语法
表达式.ActiveDocument.Revisions.Item(Index)
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取单个修订对象
const revision = await revisions.Item(1)
}
修订时间
ActiveDocument.Revisions.Item(Index).Date
修订时间
语法
表达式.ActiveDocument.Revisions.Item(Index).Date
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取单个修订对象
const revision = await revisions.Item(1)
// 获取修订时间
const date = await revision.Date
console.log(date)
}
修订作者
ActiveDocument.Revisions.Item(Index).Author
修订作者
语法
表达式.ActiveDocument.Revisions.Item(Index).Author
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取单个修订对象
const revision = await revisions.Item(1)
// 获取修订作者
const author = await revision.Author
console.log(author)
}
修订类型
ActiveDocument.Revisions.Item(Index).Type
修订类型
语法
表达式.ActiveDocument.Revisions.Item(Index).Type
表达式：文档类型应用对象
返回值
返回 Enum 中 WdRevisionType 表示对应修改类型。
其中：
0：无修改1：插入2：删除
示例
//@file=base.docx
async function example() {
await instance.ready()
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取单个修订对象
const revision = await revisions.Item(1)
// 获取修订类型
const type = await revision.Type
console.log(type)
}
修订范围
ActiveDocument.Revisions.Item(Index).Range
修订范围
语法
表达式.ActiveDocument.Revisions.Item(Index).Range
表达式：文档类型应用对象
示例
//@file=base.docx
async function example() {
await instance.ready()
// 获取修订对象
const revisions = await app.ActiveDocument.Revisions
// 获取单个修订对象
const revision = await revisions.Item(1)
// 获取修订范围
const range = await revision.Range
console.log(range)
}