Class NamedRange

NamedRange

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

访问该标签页的任何脚本都可以访问 NamedRange。为避免出现意外情况， 冲突，请考虑在范围名称前添加一个唯一字符串作为前缀。 

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var 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