Class NamedRange

命名范围

具有名称和 ID 的 Range，以便日后检索。名称不一定是唯一的；同一标签页中的多个不同范围可以共用相同的名称，就像 HTML 中的类一样。相比之下，ID 在标签页中是唯一的，就像 HTML 中的 ID 一样。NamedRange 添加到标签页后，便无法修改，只能移除。

任何访问该标签页的脚本都可以访问 NamedRange。为避免脚本之间意外发生冲突，不妨考虑为范围名称添加唯一字符串前缀。 

// Create a named range that includes every table in the active tab.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

方法

方法返回类型简介
getId()String获取此 NamedRange 的 ID。
getName()String获取此 NamedRange 的名称。
getRange()Range获取与此 NamedRange 关联的元素范围。
remove()void从标签页中移除此 NamedRange。

详细文档

getId()

获取此 NamedRange 的 ID。该 ID 在标签页中是唯一的。

返回

String - 范围的 ID，在标签页中是唯一的。

getName()

获取此 NamedRange 的名称。该名称不一定是唯一的。

返回

String - 范围的名称，不一定是唯一的。

授权

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

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

getRange()

获取与此 NamedRange 关联的元素范围。

返回

Range - 与名称和 ID 关联的元素范围。

授权

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

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

remove()

从标签页中移除此 NamedRange。此方法不会删除范围的内容，而只会移除引用。对已移除的 NamedRange 调用此方法不会产生任何效果。

授权

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

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