Class NamedRange

NamedRange

在試算表中建立、存取及修改已命名範圍。已命名範圍是指具有相關聯字串別名的範圍。您可以在「資料」>「已命名範圍...」選單下，透過 Google 試算表使用者介面查看及編輯這些範圍。

方法

方法傳回類型簡短說明
getName()String取得這個已命名範圍的名稱。
getRange()Range取得這個已命名範圍參照的範圍。
remove()void刪除這個已命名範圍。
setName(name)NamedRange設定/更新已命名範圍的名稱。
setRange(range)NamedRange設定/更新這個已命名範圍的範圍。

內容詳盡的說明文件

getName()

取得這個已命名範圍的名稱。

回攻員

String：這個已命名範圍的名稱

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getRange()

取得這個已命名範圍參照的範圍。

回攻員

Range：與這個已命名範圍相關聯的試算表範圍

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

remove()

刪除這個已命名範圍。 

// The code below deletes all the named ranges in the spreadsheet.
const namedRanges = SpreadsheetApp.getActive().getNamedRanges();
for (let i = 0; i < namedRanges.length; i++) {
  namedRanges[i].remove();
}

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

setName(name)

設定/更新已命名範圍的名稱。 

// The code below updates the name for the first named range.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
if (namedRanges.length > 1) {
  namedRanges[0].setName('UpdatedNamedRange');
}

參數

名稱類型說明
nameString已命名範圍的新名稱。

回攻員

NamedRange：呼叫設定名稱的範圍

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

setRange(range)

設定/更新這個已命名範圍的範圍。

參數

名稱類型說明
rangeRange要與這個已命名範圍建立關聯的試算表範圍。

回攻員

NamedRange：已設定試算表範圍的已命名範圍

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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