Revision

Revisions

ActiveDocument.Revisions

获取文档中的所有修订。

• 语法

  表达式.ActiveDocument.Revisions

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  }

方法

ActiveDocument.Revisions.AcceptAll()

通过AcceptAll()方法，您可以接受所有修订。

• 语法

  表达式.ActiveDocument.Revisions.AcceptAll()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //接受所有修订
    await revisions.AcceptAll();
  }

ActiveDocument.Revisions.Item()

通过Item()方法，您可以获取集合中的单个Revision对象。

• 语法

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

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

• 参数

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 获取修订集合
    const Revisions = await app.ActiveDocument.Revisions;
  
    // 获取返回集合中的单个 Revisions 对象
    await Revisions.Item(1);
  }

ActiveDocument.Revisions.Json()

通过Json()方法，您可以获取所有修订的内容。

• 语法

  表达式.ActiveDocument.Revisions.Json()

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

• 返回值

  以Array.<Object>的形式返回全部修订内容，例如[{ user, ... }]，具体返回内容如下表所示。

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

• 示例

  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.RejectAll()

通过RejectAll()方法，您可以拒绝所有修订。

• 语法

  表达式.ActiveDocument.Revisions.RejectAll()

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //拒绝所有修订
    await revisions.RejectAll();
  }

ActiveDocument.Revisions.SwitchRevisionBtn()

通过SwitchRevisionBtn()方法，您可以设置显示或隐藏接受修订和拒绝修订的按钮。

• 语法

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

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

• 参数

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //隐藏接受修订和拒绝修订的按钮
    await revisions.SwitchRevisionBtn(false);
  }

ActiveDocument.Revisions.SetRevisionMarkVisibilityByUserInfo()

通过SetRevisionMarkVisibilityByUserInfo()方法，您可以通过用户名同时设置多个用户的修订标识可见性（只对当前页面有效，刷新后需要重新设置）。

• 语法

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

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

• 参数

  UserInfos为数组，每项参数说明如下表所示。

  属性	数据类型	是否必填	描述
  userName	String	否	用户名。
  visible	Boolean	否	修订是否可见。取值范围如下： false（默认）：不可见。 true：可见。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //设置修订不可见
    await revisions.SetRevisionMarkVisibilityByUserInfo([{ userName: "user01", visible: false }]);
  }

属性

ActiveDocument.Revisions.Count

通过Count属性，您可以获取所有修订的总数量。

• 语法

  表达式.ActiveDocument.Revisions.Count

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

• 示例

  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.RevisionsMode

通过RevisionsMode属性，您可以设置以嵌入方式显示所有修订标识。

• 语法

  表达式.RevisionsMode

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

  0表示默认方式，1表示inline模式。

• 示例

  //@file=base.docx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const revisions = await app.ActiveDocument.Revisions;
  
    revisions.RevisionsMode = 1;
  }

ActiveDocument.Revisions.ShowRevisionsFrame

通过ShowRevisionsFrame属性，您可以设置显示或隐藏修订框。

• 语法

  表达式.ShowRevisionsFrame

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

  true表示显示，false表示隐藏。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //设置显示修订框
    revisions.ShowRevisionsFrame = true;
  }

Revision

ActiveDocument.Revisions.Item()

获取单个修订对象。

• 语法

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

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

• 参数

  属性	数据类型	是否必填	描述
  Index	Number	是	第Index个修订对象。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  }

方法

ActiveDocument.Revisions.Item(Index).Accept()

通过Accept()方法，您可以接受单个修订。

• 语法

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

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //接受该修订
    await revision.Accept();
  }

ActiveDocument.Revisions.Item(Index).Reject()

通过Reject()方法，您可以拒绝单个修订。

• 语法

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

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //拒绝该修订
    await revision.Reject();
  }

属性

ActiveDocument.Revisions.Item(Index).Author

通过Author属性，您可以获取单个修订的修订者名称。

• 语法

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

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

• 返回值

  返回String类型的修订者名称。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //获取该修订的修订者名称
    const author = await revision.Author;
    console.log(author);
  }

ActiveDocument.Revisions.Item(Index).Date

通过Date属性，您可以获取单个修订的日期和时间。

• 语法

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

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

• 返回值

  返回Date类型的修订日期和时间。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //获取该修订的日期和时间
    const date = await revision.Date;
    console.log(date);
  }

ActiveDocument.Revisions.Item(Index).Range

通过Range属性，您可以获取单个修订的修订范围。

• 语法

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

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

• 返回值

  返回Range类型的修订范围。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //获取该修订的修订范围
    const range = await revision.Range;
    console.log(range);
  }

ActiveDocument.Revisions.Item(Index).Type

通过Type属性，您可以获取单个修订的修订类型。

• 语法

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

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

• 返回值

  返回Enum类型的修订类型。更多信息，请参见WdRevisionType。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //获取所有修订
    const revisions = await app.ActiveDocument.Revisions;
  
    //获取第1个修订对象
    const revision = await revisions.Item(1);
  
    //获取该修订的修订类型
    const type = await revision.Type;
    console.log(type);
  }

ActiveDocument.Revisions.Item(Index).userID

通过userID属性，您可以获取修订类型。

• 语法

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

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

• 示例

  async function example() {
    await instance.ready();
  
    // 获取修订对象
    const revisions = await app.ActiveDocument.Revisions;
    
    // 获取单个修订对象
    const revision = await revisions.Item(1);
  
    // 获取修订用户ID
    const type = await revision.userID;
    console.log(type);
  }

RevisionsFilter

ActiveDocument.ActiveWindow.View.RevisionsFilter

获取与文档中的修订显示相关的当前设置。

• 语法

  表达式.ActiveDocument.ActiveWindow.View.RevisionsFilter

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

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取与文档中的修订显示相关的当前设置
    const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter;
  }

属性

ActiveDocument.ActiveWindow.View.RevisionsFilter.View

通过View属性，您可以设置修订状态为最终状态或原始状态。

• 语法

  表达式.ActiveDocument.ActiveWindow.View.RevisionsFilter.View

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

  当设置值为0时，表示最终状态；当设置值为1时，表示原始状态。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取与文档中的修订显示相关的当前设置
    const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter;
    
    //设置修订状态为原始状态
    RevisionsFilter.View = 1;
  }