Class NamedRange

命名范围

在电子表格中创建、访问和修改命名范围。命名范围是具有关联字符串别名的范围。您可以通过 Google 表格界面中的 Data > Named ranges... 菜单查看和修改这些范围。

方法

方法返回类型简介
getName()String获取此命名范围的名称。
getRange()Range获取此命名范围引用的范围。
remove()void删除此命名范围。
setName(name)NamedRange设置/更新命名范围的名称。
setRange(range)NamedRange设置/更新此命名范围的范围。

详细文档

getName()

获取此命名范围的名称。

返回

String - 此命名范围的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

获取此命名范围引用的范围。

返回

Range - 与此命名范围关联的电子表格范围

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

删除此命名范围。 

// The code below deletes all the named ranges in the spreadsheet.
const namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (let i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setName(name)

设置/更新命名范围的名称。 

// The code below updates the name for the first named range.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName('UpdatedNamedRange');
}

参数

名称类型说明
nameString命名范围的新名称。

返回

NamedRange - 名称由调用设置的范围

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRange(range)

设置/更新此命名范围的范围。

参数

名称类型说明
rangeRange要与此命名范围关联的电子表格范围。

返回

NamedRange - 为其设置了电子表格范围的命名范围

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets