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