SheetPermission

SheetPermission

返回一个保护工作表对象

属性

sheet

返回工作表信息

语法

SheetPermission.sheet

SheetPermission:保护工作表对象

返回值

Promise<Sheet>

示例

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

方法

addUsers

为用户添加该保护工作表的编辑权限

语法

SheetPermission.addUsers(users)

SheetPermission:保护工作表对象

参数

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

返回值

Promise<boolean>

示例

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

removeUsers

移除用户对该保护工作表的编辑权限

语法

SheetPermission.removeUsers(users)

SheetPermission:保护工作表对象

参数

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

返回值

Promise<boolean>

示例

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

removeAllUsers

移除所有用户对该保护工作表的编辑权限

语法

SheetPermission.removeAllUsers()

SheetPermission:保护工作表对象

返回值

Promise<boolean>

示例

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

delete

对该工作表取消保护

语法

SheetPermission.delete()

SheetPermission:保护工作表对象

返回值

Promise<boolean>

示例

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