Skip to main content

Name

Name​

返回一个名称对象

属性​

name​

返回名称的name

语法

Name.name

Name: 名称对象

返回值

Promise<string>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 获取具体的名称
  const nameName = await name.name;
  console.log(nameName);
}

value​

返回名称的value

语法

Name.value

Name: 名称对象

返回值

Promise<string>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 获取具体的值
  const value = await name.value;
  console.log(value);
}

scope​

返回名称的作用域

语法

Name.scope

Name: 名称对象

返回值

NamedItemScope

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 获取当前名称的作用域
  const scope = name.scope;
  console.log(scope);
}

visible​

当前名称是否在名称管理器中可见

语法

Name.visible

Name: 名称对象

返回值

Boolean

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 当前名称是否可见
  const visible = name.visible;
  console.log(visible);
}

worksheet​

返回名称作用域所在的工作表，如果该名称的作用域为工作簿则返回undefined

语法

Name.worksheet

Name: 名称对象

返回值

Promise<Sheet>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 获取当前名称对象的作用域
  const scope  = name.scope;
  // 如果作用域为工作表则获取sheet对象
  if (scope === Excel.NamedItemScope.Worksheet) {
      const worksheet = await name.worksheet;
  }
}

range​

返回名称对象的引用区间，如果该名称引用的不是一个合法区间则返回undefined

语法

Name.range

Name: 名称对象

返回值

Promise<Range>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象,如当前名称引用区间为=Sheet1!$A$1:$D$7
  const name = await names.item(1);
  // 获取名称的引用区间
  const range = await name.range;
  // 如果名称存在获取该名称的行列信息
  if (range) {
      const startRow = range.row;
      const startCol = range.col;
      const endRow = range.endRow;
      const endCol = range.endCol;
      const sheetName = range.getSheet().name;
  }
}

方法​

delete​

删除名称

语法

Name.delete()

Name: 名称对象

返回值

Promise<boolean>

示例

async function example() {
  // 活动工作簿
  const activeWorkbook = await Application.ActiveWorkbook;
  // 工作簿名称的集合
  const names = await activeWorkbook.Names;
  // 单个名称对象
  const name = await names.item(1);
  // 删除当前名称
  await name.delete();
}
Last updated on