金山文档开放平台

主题

回到顶部
本页内容

表格组件名称管理器相关操作 API

名称对象

ActiveWorkbook.ActiveSheet.Names

返回一个 Name 集合，该集合代表所有工作表特定的名称

语法

表达式.ActiveWorkbook.ActiveSheet.Names

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 返回一个 Name 集合，该集合代表所有工作表特定的名称
  const names = await activeSheet.Names
}

新建名称

ActiveWorkbook.ActiveSheet.Names.Add()

为单元格区域定义新名称

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Add({ Name, RefersTo })

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

参数

属性数据类型默认值必填说明
Name
String
是
名称
RefersTo
Number
否
名称引用的内容（例如 A1）

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 工作表名称的集合
  const names = await activeSheet.Names

  // 新增一个名称
  names.Add('新表', 'A1')
}

数量

ActiveWorkbook.ActiveSheet.Names.Count

工作表名称数量

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Count

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 工作表名称的集合
  const names = await activeSheet.Names

  // 查看名称数量
  const count = await names.Count
  console.log(count)
}

删除

ActiveWorkbook.ActiveSheet.Names.Item(Index).Delete()

删除名称

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Delete()

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 名称对象
  const names = await activeSheet.Names

  // 单个名称对象
  const name = await names.Item(1)

  // 删除名称
  await name.Delete()
}

名称

ActiveWorkbook.ActiveSheet.Names.Item(Index).Name

名称的 Name

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Name

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 名称对象
  const names = await activeSheet.Names

  // 单个名称对象
  const name = await names.Item(1)

  // 获取具体名称
  const nameName = await name.Name
  console.log(nameName)
}

单个名称对象

ActiveWorkbook.ActiveSheet.Names.Item(Index)

第 Index 个名称

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index)

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 名称对象
  const names = await activeSheet.Names

  // 单个名称对象
  const name = await names.Item(1)
}

值

ActiveWorkbook.ActiveSheet.Names.Item(Index).Value

名称的 Value

语法

表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Value

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

示例 

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

  const app = instance.Application

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet

  // 名称对象
  const names = await activeSheet.Names

  // 单个名称对象
  const name = await names.Item(1)

  // 获取具体的值
  const value = await name.Value
  console.log(value)
}