Class NamedRange

已命名範圍

Range 具有名稱和 ID，可供日後擷取。名稱不一定是唯一的；同一個分頁中的多個不同範圍可能會共用相同名稱，就像 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