Revisions

JSSDK: 1.3.0、FilezOffice V6 支持

由修订标记所标记的修改的集合。

属性

count

修订数量。

语法

Revisions.count

返回值

Promise<number>

示例

async function example() {
  const revisions = await Application.ActiveDocument.Revisions;
  const count = await revisions.count;
}

RevisionsMode

JSSDK: 1.8.3、FilezOffice V7.3 FP3 支持

修订标识的显示方式

语法

Revisions.RevisionsMode

值类型

Writer.WdRevisionsMode 枚举值

枚举值	数值	说明
Writer.WdRevisionsMode.wdBalloonRevisions	0	在左边距或右边距的批注框中显示修订
Writer.WdRevisionsMode.wdInLineRevisions	1	在正文中显示修订

返回值

Promise<number>

示例

async function example() {
  const Revisions = Application.ActiveDocument.Revisions;
  const mode = await Revisions.RevisionsMode;
  
  if (mode === Writer.WdRevisionsMode.wdBalloonRevisions) {
    console.log('当前为批注框模式');
  } else if (mode === Writer.WdRevisionsMode.wdInLineRevisions) {
    console.log('当前为正文模式');
  }
}

方法

acceptAll

接受所有更改。

语法

Revisions.acceptAll()

返回值

无

示例

async function example() {
  const revisions = await Application.ActiveDocument.Revisions;
  await revisions.acceptAll();
}

item

返回集合中的单个修订对象。

语法

Revisions.item(index)

参数

属性	数据类型	必填	说明
index	number	是	修订序号(序号从1开始)

返回值

Promise<Writer.Revision>

示例

async function example() {
  const revisions = await Application.ActiveDocument.Revisions;
  const revision = await revisions.item(1);
}

rejectAll

拒绝所有更改。

语法

Revisions.rejectAll()

返回值

无

示例

async function example() {
  const revisions = await Application.ActiveDocument.Revisions;
  await revisions.rejectAll();
}

setRevisionsMode

JSSDK: 1.11.0、FilezOffice v8.3 支持

设置修订标识显示模式

语法

Revisions.setRevisionsMode(value)

参数

属性	数据类型	必填	说明
value	Writer.WdRevisionsMode | number	是	修订显示模式，可以是 Writer.WdRevisionsMode 枚举值或数字： - Writer.WdRevisionsMode.wdBalloonRevisions (0)：在批注框中显示修订 - Writer.WdRevisionsMode.wdInLineRevisions (1)：在正文中显示修订

返回值

Promise<boolean>

示例

// 使用枚举值（推荐）
async function example1() {
  const Revisions = Application.ActiveDocument.Revisions;
  await Revisions.setRevisionsMode(Writer.WdRevisionsMode.wdInLineRevisions);
}

// 使用数字值（兼容旧版本）
async function example2() {
  const Revisions = Application.ActiveDocument.Revisions;
  await Revisions.setRevisionsMode(1);
}

切换修订模式需要搭配 setRevisionsMarkup 使用

示例

async function example1() {
  // 正文模式（inline模式 + 显示标记）
  await Application.ActiveDocument.ActiveWindow.setRevisionsMarkup(
    Writer.WdRevisionsMarkup.wdRevisionsMarkupAll
  );
  const Revisions = Application.ActiveDocument.Revisions;
  await Revisions.setRevisionsMode(Writer.WdRevisionsMode.wdInLineRevisions);
  const markup = await Application.ActiveDocument.ActiveWindow.revisionsMarkup;
  console.log(markup, await Revisions.RevisionsMode);
}

async function example2() {
  // 批注框模式（默认模式 + 显示标记）
  await Application.ActiveDocument.ActiveWindow.setRevisionsMarkup(
    Writer.WdRevisionsMarkup.wdRevisionsMarkupAll
  );
  const Revisions = Application.ActiveDocument.Revisions;
  await Revisions.setRevisionsMode(Writer.WdRevisionsMode.wdBalloonRevisions);
  const markup = await Application.ActiveDocument.ActiveWindow.revisionsMarkup;
  console.log(markup);  
}

async function example3() {
  // 最终模式（不显示标记）
  await Application.ActiveDocument.ActiveWindow.setRevisionsMarkup(
    Writer.WdRevisionsMarkup.wdRevisionsMarkupNone
  );
  const markup = await Application.ActiveDocument.ActiveWindow.revisionsMarkup;
  console.log(markup);
}

toJson

获取文档里包含的所有修订。

语法

Revisions.toJson()

返回值

Promise<Object[]>，修订信息的数组，具体信息如下：

属性	数据类型	说明
author	string	用户名称
date	string	修订的日期和时间
type	Writer.RevisionType	修订的类型
isStyle	boolean	是否是修改样式的修订

示例

async function example() {
  const revisions = await Application.ActiveDocument.Revisions;
  const json = await revisions.toJson();
}