RangePermission

RangePermission

返回一个保护区域对象

属性

range

返回当前区域保护的区间

语法

RangePermission.range

RangePermission:保护区域对象

返回值

Promise<Range>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet()
  // 获取活动工作表内保护区域对象的集合
  const rangePermissions = await activeWorksheet.RangePermissions;
  // 获取保护区域对象
  const rangePermission = await rangePermissions.item(1);
  // 获取区间
  const range = await rangePermission.range;
}

方法

addUsers

为用户添加该区域的编辑权限

语法

RangePermission.addUsers(users)

RangePermission:保护区域对象

参数

属性	数据类型	必填	说明
users	string[]	是	用户ID，可以同时添加多个用户

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet();
  // 获取活动工作表内保护区域对象的集合
  const rangePermissions = await activeWorksheet.RangePermissions;
  // 获取保护区域对象
  const rangePermission = await rangePermissions.item(1);
  // 对用户1，用户2添加该区域的编辑权限
  // test01、test02为用户1、用户2的ID
  await rangePermission.addUsers(['test01','test02']);
}

removeUsers

移除用户对该区域的编辑权限

语法

RangePermission.removeUsers(users)

RangePermission:保护区域对象

参数

属性	数据类型	必填	说明
users	string[]	是	用户ID，可以同时移除多个用户

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet();
  // 获取活动工作表内保护区域对象的集合
  const rangePermissions = await activeWorksheet.RangePermissions;
  // 获取保护区域对象
  const rangePermission = await rangePermissions.item(1);
  // 移除用户1，用户2对该区域的编辑权限
  // test01、test02为用户1、用户2的ID
  await rangePermission.removeUsers(['test01','test02']);
}

removeAllUsers

移除所有用户对该区域的编辑权限

语法

RangePermission.removeAllUsers()

RangePermission:保护区域对象

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet();
  // 获取活动工作表内保护区域对象的集合
  const rangePermissions = await activeWorksheet.RangePermissions;
  // 获取保护区域对象
  const rangePermission = await rangePermissions.item(1);
  // 移除所有用户对该区域的编辑权限
  await rangePermission.removeAllUsers();
}

delete

对该区域取消保护

语法

RangePermission.delete()

RangePermission:保护区域对象

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook
  // 活动工作表
  const activeWorksheet = await activeWorkbook.getActiveSheet();
  // 获取活动工作表内保护区域对象的集合
  const rangePermissions = await activeWorksheet.RangePermissions;
  // 获取保护区域对象
  const rangePermission = await rangePermissions.item(1);
  // 取消保护
  await rangePermission.delete();
}