Names_智能媒体管理(IMM)-阿里云帮助中心

本文介绍与表格文档Names相关的API。

Name

ActiveWorkbook.ActiveSheet.Names.Item(Index)

获取活动工作表中的单个名称对象。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index)
表达式：文档类型应用对象

示例

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).Delete()

通过Delete()方法，您可以删除活动工作表中的单个名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Delete()
表达式：文档类型应用对象

示例

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
表达式：文档类型应用对象

示例

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).Value

通过Value属性，您可以获取单个名称对象的值。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Value
表达式：文档类型应用对象

示例

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);
}

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

重要

JS-SDK V1.1.19及以上版本支持此功能。

通过RefersToRange属性，可以获取返回 Name 对象引用的 Range 对象

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).RefersToRange
表达式：文档类型应用对象

示例

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 range = await name.RefersToRange;
}

Names

ActiveWorkbook.ActiveSheet.Names

获取活动工作表的所有名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;
}

方法

ActiveWorkbook.ActiveSheet.Names.Add()

通过Add()方法，您可以为指定单元格定义新名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Add({ Name, RefersTo })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Name
String
是
新名称。
RefersTo
Number
否
需要定义新名称的单元格。

示例

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

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //为A1单元格定义一个新名称
  names.Add('新表', 'A1');
}

ActiveWorkbook.ActiveSheet.Names.ValidNewName()

通过ValidNewName()方法，您可以检查指定名称是否合法。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.ValidNewName({ Name })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Name
String
是
名称。

示例

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

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //检查名称是否合法
  names.ValidNewName('新表');
}

ActiveWorkbook.ActiveSheet.Names.Item(Index)

重要

JS-SDK V1.1.3及以上版本支持此功能。

通过Item属性，您可以获取第 Index 个名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index)
表达式：文档类型应用对象

示例

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.Count

通过Count属性，您可以获取活动工作表中的名称数量。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Count
表达式：文档类型应用对象

示例

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);
}

属性	数据类型	是否必填	描述
Name	String	是	新名称。
RefersTo	Number	否	需要定义新名称的单元格。