具有名称和 ID 以供日后检索的 Range
。名称不一定是独一无二的;同一文档中的多个不同范围可以使用相同的名称,很像 HTML 中的类。相比之下,ID 在文档中是唯一的,就像 HTML 中的 ID 一样。NamedRange
添加到文档后便无法修改,只能移除。
访问文档的任何脚本都可以访问 NamedRange
。为避免脚本之间发生意外冲突,请考虑在范围名称前添加一个唯一字符串作为前缀。
// Create a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.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()
remove()
从文档中移除此NamedRange
。此方法不会删除相应范围的内容,而只是移除引用。对已移除的 NamedRange
调用此方法不会产生任何影响。
授权
使用此方法的脚本需要通过以下一个或多个范围进行授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents