表格(Sheet)

Sheet 对象，表示表格相关

方法列表

方法	说明
AddSheet()	新建数据表
DeleteSheet()	删除当前数据表（Sheet）
GetActiveSheetIndex()	返回当前 Sheet 的索引
GetDateFormat()	获取日期格式
GetNumberFormat()	获取数字格式
GetTimeFormat()	获取时间格式
RenameSheet()	根据传入的 Name，重命名数据表（Sheet）
SetActiveSheet()	根据传入 SheetIndex，切换数据表（Sheet）
SetRenderDefBgColor()	设置默认背景色

AddSheet()

新建数据表

语法

表达式.ActiveDBSheet.Sheet.AddSheet()

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

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新建数据表
  await app.ActiveDBSheet.Sheet.AddSheet()
}

DeleteSheet()

删除当前数据表（Sheet）

语法

表达式.ActiveDBSheet.Sheet.DeleteSheet()

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

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 删除当前数据表（Sheet）
  await app.ActiveDBSheet.Sheet.DeleteSheet()
}

GetActiveSheetIndex()

返回当前 Sheet 的索引

语法

表达式.ActiveDBSheet.Sheet.GetActiveSheetIndex()

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

返回值

以 Number 形式返回表示当前 Sheet 的索引

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 返回当前 Sheet 的索引
  const index = await app.ActiveDBSheet.Sheet.GetActiveSheetIndex()
  console.log(index)
}

GetDateFormat()

获取日期格式

语法

表达式.ActiveDBSheet.Sheet.GetDateFormat()

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

返回值

返回对应的日期格式

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取日期格式
  const info = await app.ActiveDBSheet.Sheet.GetDateFormat()
  console.log(info)
}

GetNumberFormat()

获取数字格式

语法

表达式.ActiveDBSheet.Sheet.GetNumberFormat()

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

返回值

返回对应的数字格式

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取数字格式
  const info = await app.ActiveDBSheet.Sheet.GetNumberFormat()
  console.log(info)
}

GetTimeFormat()

获取时间格式

语法

表达式.ActiveDBSheet.Sheet.GetTimeFormat()

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

返回值

返回对应的时间格式

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取时间格式
  const info = await app.ActiveDBSheet.Sheet.GetTimeFormat()
  console.log(info)
}

RenameSheet()

根据传入的 Name，重命名数据表（Sheet）

语法

表达式.ActiveDBSheet.Sheet.RenameSheet({ SheetIndex, Name })

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

参数

属性	数据类型	默认值	必填	说明
SheetIndex	Number		是	第 SheetIndex 个数据表，从 1 开始
Name	String		是	新的数据表（Sheet）名词

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据传入的 Name，重命名数据表（Sheet）
  // 重命名数据表为 'WebOffice'
  await app.ActiveDBSheet.Sheet.RenameSheet({
    SheetIndex: 1,
    Name: 'WebOffice'
  })
}

SetActiveSheet()

根据传入 SheetIndex，切换数据表（Sheet）

语法

表达式.ActiveDBSheet.Sheet.SetActiveSheet({ SheetIndex })

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

参数

属性	数据类型	默认值	必填	说明
SheetIndex	Number		是	切换到数据表（Sheet）的索引

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据传入 SheetIndex，切换数据表（Sheet）
  // 切换到第 2 个数据表
  await app.ActiveDBSheet.Sheet.SetActiveSheet({ SheetIndex: 2 })
}

SetRenderDefBgColor()

设置默认背景色

说明

仅当前视图有效，切换视图后设置失效

语法

表达式.ActiveDBSheet.View.SetRenderDefBgColor({ Color })

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

参数

属性	数据类型	默认值	必填	说明
Color	String		是	颜色

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 设置默认背景色
  await app.ActiveDBSheet.Sheet.SetRenderDefBgColor({
    Color: '#fff'
  })
}