Workbook

Workbook

当前工作簿

属性

Names

返回当前工作簿的所有名称的集合

语法 Application.ActiveWorkbook.Names

返回值 Promise<Names>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook
  // 工作簿名称集合
  const names = await activeWorkbook.Names
}

SheetPermissions

返回当前工作簿所有保护工作表的集合

语法

Application.ActiveWorkbook.SheetPermissions

返回值

Promise<SheetPermissions>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿保护工作表集合
  const sheetPermissions = await activeWorkbook.SheetPermissions;
}

Protection

返回工作簿结构保护对象

语法

Application.ActiveWorkbook.Protection

Application：表格应用对象

返回值

Promise<WorkBookProtection>

示例

async function example() {
  const Protection =  await Application.ActiveWorkbook.Protection;
  console.log(Protection);
}

方法

switchDataProtectionMode

JSSDK: 1.0.3、zOffice2022.1 FP3 支持

开启/关闭数据保护

语法

Application.ActiveWorkbook.switchDataProtectionMode()

返回值

Promise<boolean>

示例

async function example() {
  const success = await Application.ActiveWorkbook.switchDataProtectionMode();
  console.log(success);
}

isDataProtectionOn

JSSDK: 1.0.3、zOffice2022.1 FP3 支持

数据保护是否开启

语法

Application.ActiveWorkbook.isDataProtectionOn()

返回值

Promise<boolean>

示例

async function example() {
  const isOpen = await Application.ActiveWorkbook.isDataProtectionOn();
  console.log(isOpen);
}

save

保存文档

语法

Application.ActiveWorkbook.save()

返回值

Promise<boolean>

示例

async function example() {
  await Application.ActiveWorkbook.save();
}

getSheets

返回所有工作表对象

语法

Application.ActiveWorkbook.getSheets()

Application：表格应用对象

返回值

Promise<Excel.Sheet[]>

示例

async function example() {
  const sheets = await Application.ActiveWorkbook.getSheets();
}

getActiveSheet

当前活动工作表

语法

Application.ActiveWorkbook.getActiveSheet()

Application：表格应用对象

返回值

Promise<Excel.Sheet>

示例

async function example() {
  const sheet = await Application.ActiveWorkbook.getActiveSheet();
}

getSheetByName

根据工作表名称返回工作表对象

语法

Application.ActiveWorkbook.getSheetByName(name)

Application：表格应用对象

参数

属性	数据类型	必填	说明
name	string	是	工作表名称

返回值

Promise<Excel.Sheet>

示例

async function example() {
  const sheet = await Application.ActiveWorkbook.getSheetByName('sheet1');
}

newSheet

新建工作表

语法

Application.ActiveWorkbook.newSheet(name)

Application：表格应用对象

参数

属性	数据类型	必填	说明
name	string	是	新建的工作表的名称

返回值

Promise<boolean>

示例

async function example(rName) {
  const success = await Application.ActiveWorkbook.newSheet(rName);
  console.log(success);
}

print

打印工作簿

语法

Application.ActiveWorkbook.print()

Application：表格应用对象

返回值

Promise<boolean>

示例

async function example() {
  const success = await Application.ActiveWorkbook.print();
}

getProtection

获取工作簿结构保护对象

语法

Application.ActiveWorkbook.getProtection()

Application：表格应用对象

返回值

Promise<Excel.WorkBookProtection>

示例

async function example() {
  const Protection = await Application.ActiveWorkbook.getProtection();
}