Revision
本文介绍与文字文档Revision相关的API。
Revisions
ActiveDocument.Revisions
获取文档中的所有修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Revisions
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有修订 const revisions = await app.ActiveDocument.Revisions; }
方法
ActiveDocument.Revisions.AcceptAll()
通过AcceptAll()
方法,您可以接受所有修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Revisions.AcceptAll()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有修订 const revisions = await app.ActiveDocument.Revisions; //接受所有修订 await revisions.AcceptAll(); }
ActiveDocument.AcceptAllRevisionsShown()
通过AcceptAllRevisionsShown()
方法,您可以接受文档中指定审阅者的所有修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.AcceptAllRevisionsShown()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取第1个已修订过的文档的单个审阅者 const ActiveDocument = await app.ActiveDocument.ActiveWindow.View.ActiveDocuments.Item(1); //允许对审阅者对应修订进行操作 ActiveDocument.Visible = true; //接受文档中指定审阅者的所有修订 await app.ActiveDocument.AcceptAllRevisionsShown(); }
ActiveDocument.Revisions.Json()
通过Json()
方法,您可以获取所有修订的内容。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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()
方法,您可以拒绝所有修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Revisions.RejectAll()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取所有修订 const revisions = await app.ActiveDocument.Revisions; //拒绝所有修订 await revisions.RejectAll(); }
ActiveDocument.RejectAllRevisionsShown()
通过RejectAllRevisionsShown()
方法,您可以拒绝文档中指定审阅者的所有修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.RejectAllRevisionsShown()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取第1个已修订过的文档的单个审阅者 const ActiveDocument = await app.ActiveDocument.ActiveWindow.View.ActiveDocuments.Item(1); //允许对审阅者对应修订进行操作 ActiveDocument.Visible = true; //拒绝文档中指定审阅者的所有修订 await app.ActiveDocument.AcceptAllRevisionsShown(); }
ActiveDocument.Revisions.SwitchRevisionBtn()
通过SwitchRevisionBtn()
方法,您可以设置显示或隐藏接受修订和拒绝修订的按钮。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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()
方法,您可以通过用户名同时设置多个用户的修订标识可见性(只对当前页面有效,刷新后需要重新设置)。
JS-SDK V1.1.12及以上版本支持此功能。
语法
表达式.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
属性,您可以获取所有修订的总数量。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以设置以嵌入方式显示所有修订标识。
JS-SDK V1.1.16及以上版本支持此功能。
语法
表达式.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
属性,您可以设置显示或隐藏修订框。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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()
获取单个修订对象。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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()
方法,您可以接受单个修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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()
方法,您可以拒绝单个修订。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以获取单个修订的修订者名称。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以获取单个修订的日期和时间。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以获取单个修订的修订范围。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以获取单个修订的修订类型。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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); }
RevisionsFilter
ActiveDocument.ActiveWindow.View.RevisionsFilter
获取与文档中的修订显示相关的当前设置。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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
属性,您可以设置修订状态为最终状态或原始状态。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.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; }
ActiveDocument.ActiveWindow.View.ShowRevisionsAndComments
通过ShowRevisionsAndComments
属性,配合ActiveDocument.ActiveWindow.View.RevisionsFilter.View
,您可以设置修订的标记状态,即是否显示修订的标记。修订状态包括显示标记的最终状态、最终状态、显示标记的原始状态和原始状态四种。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.ActiveWindow.View.ShowRevisionsAndComments
表达式:文档类型应用对象
示例
设置修订状态为“显示标记的最终状态”
async function example() { await instance.ready(); const app = instance.Application; //获取与文档中的修订显示相关的当前设置 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; //设置修订状态为最终状态 RevisionsFilter.View = 0; //设置修订状态为显示标记的最终状态 View.ShowRevisionsAndComments = true; }
设置修订状态为“最终状态”
async function example() { await instance.ready(); const app = instance.Application; //获取与文档中的修订显示相关的当前设置 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; //设置修订状态为最终状态 RevisionsFilter.View = 0; //设置修订状态为最终状态,即不显示修订 View.ShowRevisionsAndComments = false; }
设置修订状态为“显示标记的原始状态”
async function example() { await instance.ready(); const app = instance.Application; //获取与文档中的修订显示相关的当前设置 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; //设置修订状态为原始状态 RevisionsFilter.View = 1; //设置修订状态为显示标记的原始状态 View.ShowRevisionsAndComments = true; }
设置修订状态为“原始状态”
async function example() { await instance.ready(); const app = instance.Application; //获取与文档中的修订显示相关的当前设置 const RevisionsFilter = await app.ActiveDocument.ActiveWindow.View.RevisionsFilter; //设置修订状态为原始状态 RevisionsFilter.View = 1; //设置修订状态为原始状态,即不显示标记 View.ShowRevisionsAndComments = false; }