金山文档开放平台

主题

回到顶部
本页内容

表格组件活动工作簿操作相关 API

活动工作簿对象

ActiveWorkbook

返回一个表示活动窗口中的工作簿的工作簿对象

语法

表达式.ActiveWorkbook

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook
}

名称管理器

ActiveWorkbook.Names

工作簿名称的集合，使用方法可参考 名称管理器

语法

表达式.ActiveWorkbook

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 工作簿名称集合
  const names = await activeWorkbook.Names
}

工作表对象

ActiveWorkbook.Sheets

工作表对象

语法

表达式.ActiveWorkbook.Sheets

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 工作表对象
  const sheets = await app.ActiveWorkbook.Sheets
}

新增工作表

ActiveWorkbook.Sheets.Add()

新增工作表

语法

表达式.ActiveWorkbook.Sheets.Add({ Before, After, Count, Type, Name })

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
Before
String/Number
是
指定工作表的对象，新建的工作表将置于此工作表之前
After
String/Number
否
指定工作表的对象，新建的工作表将置于此工作表之后
Count
Number
1
否
要添加的工作表数。默认值为选定工作表的数量
Type
Enum
否
指定工作表类型，详细可见 Enum.XlSheetType
Name
Name
否
指定工作表名称

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 工作表对象
  const sheets = await app.ActiveWorkbook.Sheets

  // 添加工作表
  await sheets.Add(null, null, 1, app.Enum.XlSheetType.xlWorksheet, '新工作表')
}

工作表数量

ActiveWorkbook.Sheets.Count

工作表数量

语法

表达式.ActiveWorkbook.Sheets.Count

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 工作表对象
  const sheets = await app.ActiveWorkbook.Sheets

  // 工作表数量
  const count = await sheets.Count
  console.log(count)
}

工作表类型

ActiveWorkbook.Sheets.Item(Index).Type

工作表类型

JSSDK: v1.1.10+、WebOffice v2.3.1+ 支持

语法

表达式.ActiveWorkbook.Sheets.Item(Index).Type

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 工作表对象
  const sheetIndex = 2 // Sheets 序号，从 1 开始
  const sheet = await app.ActiveWorkbook.Sheets.Item(sheetIndex)

  // 工作表类型
  const Type = await sheet.Type
  console.log(Type)
}

单个工作表对象

ActiveWorkbook.Sheets.Item(Index)

活动工作簿中的活动工作表

注意目前该对象（WorkSheet）可以和活动工作表（ActiveSheet）一样使用

语法

表达式.ActiveWorkbook.Sheets.Item(Index)

表达式：文档类型应用对象

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.Sheets.Item(1)
}

开关多人同步筛选

ActiveWorkbook.SetFilterShared()

开关多人同步筛选

语法

表达式.ActiveWorkbook.SetFilterShared({ Checked })

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
Checked
Boolean
是
开启 true，关闭 false

示例 

//@file=base.xlsx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 活动工作簿
  const activeWorkbook = await app.ActiveWorkbook

  // 开启多人同步筛选
  const result = await activeWorkbook.SetFilterShared()
}