WebOffice 开放平台

主题

回到顶部
本页内容

修订(Revisions)

修订对象

属性列表

属性说明
Count
指定文档的所有修订数量
RevisionsMode
以嵌入方式显示所有修订标识
ShowRevisionsFrame
设置修订框显示/隐藏

方法列表

方法说明
AcceptAll()
接受对指定文档的所有修订
Json()
获取全文修订内容
RejectAll()
拒绝所有修订
SetRevisionMarkVisibilityByUserInfo()
通过用户名同时设置多个用户的修订标识可见性（只对当前页面有用，刷新后需要重新设置）
SwitchRevisionBtn()
显示或者隐藏接受修订/拒绝修订的按钮
Item()
返回集合中的单个 Revision 对象
Item(Index).Author
修订作者
Item(Index).Date
修订时间
Item(Index).Range
修订范围
Item(Index).Type
修订类型
Item(Index).Accept()
接受单个修订的修改
Item(Index).Reject()
拒绝单个修订的修改

Count

指定文档的所有修订数量

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 获取全文修订数量
  const count = await revisions.Count
  console.log(count)
}

RevisionsMode

以嵌入方式显示所有修订标识

参数

0: 默认方式、1: inline 模式

示例

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

  const app = instance.Application

  const revisions = await app.ActiveDocument.Revisions

  revisions.RevisionsMode = 1
}

ShowRevisionsFrame

设置修订框显示/隐藏

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 设置修订框显示
  revisions.ShowRevisionsFrame = true

  setTimeout(() => {
    // 修订框隐藏
    revisions.ShowRevisionsFrame = false
  }, 2000)
}

AcceptAll()

接受对指定文档的所有修订

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 接受对指定文档的所有修订
  await revisions.AcceptAll()
}

Json()

获取全文修订内容

语法

表达式.ActiveDocument.Revisions.Json()

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

返回值

将以 Array.<Object> 的形式返回全部修订内容，例如 [{ user, ... }]，具体返回情况如下：

属性数据类型说明
user
String
用户名
leader
String
修订批注
begin
Number
修订开始位置
end
Number
修订结束位置
content
String
修订后内容
type
String
修订类型
date
Number
时间戳

示例

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

RejectAll()

拒绝所有修订

语法

表达式.ActiveDocument.Revisions.RejectAll()

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

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 拒绝对指定文档的所有修订
  await revisions.RejectAll()
}

SetRevisionMarkVisibilityByUserInfo()

通过用户名同时设置多个用户的修订标识可见性（只对当前页面有用，刷新后需要重新设置）

语法

表达式.ActiveDocument.Revisions.SetRevisionMarkVisibilityByUserInfo(UserInfos)

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

参数

参数 UserInfos 为数组，每项是一个对象，参数如下

属性数据类型默认值必填说明
userName
String
-
否
用户名
visible
Boolean
false
否
修订是否可见

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 设置用户修订不可见
  await revisions.SetRevisionMarkVisibilityByUserInfo([
    { userName: 'xxx', visible: false }
  ])
}

SwitchRevisionBtn()

接受

显示或者隐藏接受修订/拒绝修订的按钮

语法

表达式.ActiveDocument.Revisions.SwitchRevisionBtn({ Value })

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

参数

Value 为 Boolean 格式，为 true 表示显示接受/拒绝修订的按钮，为 false 表示隐藏接受/拒绝修订的按钮。

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 隐藏接受/拒绝修订的按钮
  await revisions.SwitchRevisionBtn(false)
}

Item()

返回集合中的单个 Revision 对象

语法

表达式.ActiveDocument.Revisions.Item(Index)

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

参数

属性数据类型默认值必填说明
Index
Number
是
第 Index 个修订对象

示例

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

  const app = instance.Application

  // 获取修订集合
  const Revisions = await app.ActiveDocument.Revisions

  // 获取返回集合中的单个 Revisions 对象
  await Revisions.Item(1)
}

Item(Index).Author

修订作者

语法

表达式.ActiveDocument.Revisions.Item(Index).Author

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

返回值

通过 String 表示对应的修订用户的名称

示例

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

Item(Index).Date

修订时间

语法

表达式.ActiveDocument.Revisions.Item(Index).Date

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

返回值

通过 Date 表示对应的修订日期和时间

示例

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

Item(Index).Range

修订范围

语法

表达式.ActiveDocument.Revisions.Item(Index).Range

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

返回值

返回一个 Range 对象，表示该修订包含的文档范围部分

示例

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

Item(Index).Type

修订类型

语法

表达式.ActiveDocument.Revisions.Item(Index).Type

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

返回值

返回 Enum 中 WdRevisionType 表示对应修改类型。

其中：

  • 0：无修改
  • 1：插入
  • 2：删除

示例

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

Item(Index).Accept()

接受

接受单个修订的修改

语法

表达式.ActiveDocument.Revisions.Item(Index).Accept()

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

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 获取单个修订对象
  const revision = await revisions.Item(1)

  // 接受第 1 个修订的修改
  await revision.Accept()
}

Item(Index).Reject()

拒绝

拒绝单个修订的修改

语法

表达式.ActiveDocument.Revisions.Item(Index).Reject()

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

示例

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

  const app = instance.Application

  // 获取修订对象
  const revisions = await app.ActiveDocument.Revisions

  // 获取单个修订对象
  const revision = await revisions.Item(1)

  // 拒绝第 1 个修订的修改
  await revision.Reject()
}