Skip to main content

SheetPermissions

SheetPermissions​

返回一个保护工作表对象的集合

属性​

count​

返回当前工作簿中受保护工作表的数量

语法

SheetPermissions.count

SheetPermissions:保护工作表集合对象

返回值

Promise<number>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 获取活动工作簿中保护工作表对象的集合
  const sheetPermissions = await activeWorkbook.SheetPermissions;
  // 获取活动工作簿中受保护工作表的数量
  const count = await sheetPermissions.count;
  console.log(count);
}

方法​

add​

对一个工作表添加保护

语法

SheetPermissions.add(type, sheet, users, description)

SheetPermissions:保护工作表集合对象

参数

属性数据类型必填说明
typePermissionType是保护的类型
sheetExcel.Sheet否添加保护的工作表（默认为当前工作表）
usersstring[]否对保护工作表拥有编辑权限的用户
descriptionstring否描述信息

返回值

Promise<SheetPermission>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 获取保护工作表对象的集合
  const sheetPermissions = await activeWorkbook.SheetPermissions;
  // 一、对当前工作表添加隐藏类型的保护
  const sheet1PerMission = await sheetPermissions.add(Excel.PermissionType.Hide);
  // 二、对指定工作表添加只读类型的保护
  const sheet2 = await activeWorkbook.getSheetByName('Sheet2');
  const sheet2Permission = await sheetPermissions.add(Excel.PermissionType.ReadOnly, sheet2);
  // 三、对指定工作表添加只读类型的保护，同时指定用户1、用户2可以编辑
  // test01、test02为用户1、用户2的ID
  const sheet2Permission1 = await sheetPermissions.add(Excel.PermissionType.ReadOnly, sheet2, ['test01','test02']);
}

item​

返回一个保护工作表对象

语法

SheetPermissions.item(index)

SheetPermissions:保护工作表集合对象

参数

属性数据类型必填说明
indexnumber是对象的索引值

返回值

Promise<SheetPermission>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 获取保护工作表对象的集合
  const sheetPermissions = await activeWorkbook.SheetPermissions;
  // 获取第一个保护工作表对象
  const sheetPermission = await sheetPermissions.item(1);
}

deleteAll​

对当前工作簿所有工作表取消保护

语法

SheetPermissions.deleteAll()

SheetPermissions:保护工作表集合对象

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 获取保护工作表对象的集合
  const sheetPermissions = await activeWorkbook.SheetPermissions;
  // 取消活动工作簿中所有工作表的保护
  await sheetPermissions.deleteAll();
}
Last updated on