Skip to content

表格组件会议操作相关 API

激活工作表的 index

ActiveSheet.Index

激活工作表的 index

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveSheet.Index

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

示例

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

  const app = instance.Application

  // 激活工作表的index
  const Index = await app.ActiveSheet.Index
  console.log(Index)
}

关闭所有打开的下拉面板

ActiveWorkbook.CloseDropdownPanels()

通知所有打开的下拉面板关闭

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWorkbook.CloseDropdownPanels()

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

示例

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

  const app = instance.Application

  // 通知所有打开的下拉面板关闭
  await app.ActiveWorkbook.CloseDropdownPanels()
}

关闭超链接

ActiveWorkbook.CloseHyperLink()

通知超链接关闭

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWorkbook.CloseHyperLink()

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

示例

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

  const app = instance.Application

  // 通知超链接关闭
  await app.ActiveWorkbook.CloseHyperLink()
}

一个单元格或单元格区域

ActiveSheet.Range

一个单元格或单元格区域,返回一个 Range 对象(可使用 Range 相关的属性、方法)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveSheet.Range

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

示例

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

  const app = instance.Application

  // 工作表对象
  const Sheet = await app.ActiveSheet

  // 一个单元格或单元格区域
  const Range = await Sheet.Range

  // 指定单元格
  const range = await Range("D2")

  // 选中D2单元格
  await range.Select()
}

工作表上的所用区域

ActiveSheet.UsedRange

工作表上的所用区域,返回一个 Range 对象(可使用 Range 相关的属性、方法)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveSheet.UsedRange

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

示例

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

  const app = instance.Application

  // 工作表对象
  const Sheet = await app.ActiveSheet

  // 工作表上的所用区域
  const UsedRange = await Sheet.UsedRange

  // 选中所用区域
  UsedRange.Select()
}

工作表上的单元格

ActiveSheet.Cells

工作表上的单元格,返回一个 Range 对象(可使用 Range 相关的属性、方法)

语法

表达式.ActiveSheet.Cells

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

示例

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

  const app = instance.Application

  // 工作表对象
  const Sheet = await app.ActiveSheet

  // 单元格对象
  const cells = await Sheet.Cells

  // 指定单元格
  const cell = await cells.Item(1)
  // 或者 cell = await cells(1)

  // 选中第 1 个单元格
  await cell.Select()
}

工作表上的列

ActiveSheet.Columns

工作表上的列,返回一个 Range 对象(可使用 Range 相关的属性、方法)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveSheet.Columns

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

示例

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

  const app = instance.Application

  // 工作表对象
  const Sheet = await app.ActiveSheet

  // 列对象
  const Columns = await Sheet.Columns

  // 指定列
  const column = await Columns.Item(1)
  // 或者 column = await Columns(1)

  // 选中第 1 个列
  await column.Select()
}

监听选区改变

Sub.Worksheet_SelectionChange

监听选区改变事件

语法

表达式.Sub.Worksheet_SelectionChange = Function

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

示例

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

  const app = instance.Application

  // 监听选区改变事件
  app.Sub.Worksheet_SelectionChange = e => {
    console.log('SelectionChange', e)
  }
}

工作表上的行

ActiveSheet.Rows

工作表上的行,返回一个 Range 对象(可使用 Range 相关的属性、方法)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveSheet.Rows

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

示例

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

  const app = instance.Application

  // 工作表对象
  const Sheet = await app.ActiveSheet

  // 行对象
  const Rows = await Sheet.Rows

  // 指定行
  const row = await Rows.Item(1)
  // 或者 row = await Rows(1)

  // 选中第 1 行
  await row.Select()
}

退出编辑

ActiveWorkbook.QuitCellEdit()

退出编辑

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWorkbook.QuitCellEdit()

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

示例

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

  const app = instance.Application

  // 退出编辑
  await app.ActiveWorkbook.QuitCellEdit()
}

监听强制横屏

Sub.Worksheet_ForceLandscape

监听强制横屏时通知

语法

表达式.Sub.Worksheet_ForceLandscape = Function

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

示例

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

  const app = instance.Application

  // 监听强制横屏时通知
  app.Sub.Worksheet_ForceLandscape = e => {
    console.log('ForceLandscape', e)
  }
}

监听滚动画布行为

Sub.Worksheet_ScrollChange

监听用户自己的滚动画布行为

语法

表达式.Sub.Worksheet_ScrollChange = Function

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

示例

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

  const app = instance.Application

  // 监听用户自己的滚动画布行为
  app.Sub.Worksheet_ScrollChange = () => {
    console.log('ScrollChange')
  }
}

关闭筛选 hover 提示

ActiveWorkbook.CloseFilterTips()

关闭筛选 hover 提示

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWorkbook.CloseFilterTips()

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

示例

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

  const app = instance.Application

  // 关闭筛选hover提示
  await app.ActiveWorkbook.CloseFilterTips()
}

可视区域最左侧的列号

ActiveWindow.ScrollColumn

可视区域最左侧的列号设置和获取

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWindow.ScrollColumn

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

返回值

返回 Number 型的可视区的列数

示例

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

  const app = instance.Application

  // 获取左侧的列号
  const ScrollColumn = await app.ActiveWindow.ScrollColumn
  console.log(ScrollColumn)

  // 设置左侧的列号
  app.ActiveWindow.ScrollColumn = 10
}

可视区域最上面的行号

ActiveWindow.ScrollRow

可视区域最上面的行号设置和获取

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

语法

表达式.ActiveWindow.ScrollRow

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

返回值

返回 Number 型的可视区的行数

示例

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

  const app = instance.Application

  // 获取最上面的行号
  const ScrollRow = await app.ActiveWindow.ScrollRow
  console.log(ScrollRow)

  // 设置最上面的行号
  app.ActiveWindow.ScrollRow = 10
}