PermMarks

PermMarks

JSSDK: 1.2.2、zOffice2022.3 FP2 支持

内容保护文档的可编辑区域对象集合

属性

count

可编辑区域的数量

语法

Application.ActiveDocument.PermMarks.count

Application: 文档类型应用对象

返回值

count: Promise<number>

示例

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

方法

item

根据参数获取可编辑区域

语法

document.PermMarks.item(key)

document: 文档类型应用对象

参数

属性	数据类型	必填	说明
key	string | number	是	可编辑区域name/序号(序号从1开始)

返回值

Promise<Word.PermMark>

示例

async function example(key) {
  const permMark = await Application.ActiveDocument.PermMarks.item(key);
}

add

JSSDK: 1.7.1、zOffice V7.2 FP1 支持

以Range为范围添加可编辑区域

语法

document.PermMarks.add(name, option, range, bHide)

document: 文档类型应用对象

参数

属性	数据类型	必填	说明
name	string	是	可编辑区域名称
option	object	是	可编辑区域用户信息 { "group": ["everyone"] } 或者 { "users": string[] } // 用户ID
range	Word.Range	否	要插入可编辑区域的区域（默认在当前选区插入）
bHide	boolean	否	是否对不可编辑的用户不可见，默认 false，即仅可见

返回值

Promise<Word.PermMark>

示例

async function example1() {
  const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
  const range = await bookmark.range;
  
  // 在指定书签区域插入一个所有人可编辑的可编辑区域，名称为pm1
  const permMark1 = await Application.ActiveDocument.PermMarks.add('pm1', {"group":["everyone"]}, range);
  // 在指定书签区域插入一个仅有用户 test01 可编辑的可编辑区域，其他人仅可见，名称为pm2
  const permMark2 = await Application.ActiveDocument.PermMarks.add('pm2', {"users":["test01"]}, range);
  // 在指定书签区域插入一个仅有用户 test01 可编辑的可编辑区域，其他人不可见，名称为pm3
  const permMark3 = await Application.ActiveDocument.PermMarks.add('pm3', {"users":["test01"]}, range, true);
}

// 在当前选区插入一个仅有用户 test01 可编辑的可编辑区域，其他人仅可见，名称为pm
async function example1() {
  const permMark = await Application.ActiveDocument.PermMarks.add('pm', {"users":["test01"]});
}

toJson

获取文档里包含的所有可编辑区域

语法

document.PermMarks.toJson()

document：文档类型应用对象

返回值

Promise<string[]>，可编辑区域名称的数组

示例

async function example() {
  const permMarks = await Application.ActiveDocument.PermMarks.toJson();
}