Class NamedRange

名前付き範囲

後で取得できるように名前と ID が付いた Range。名前は一意である必要はありません。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 - 範囲の名前。一意である必要はありません。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getRange()

この NamedRange に関連付けられている要素の範囲を取得します。

戻る

Range - 名前と ID に関連付けられている要素の範囲。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

remove()

この NamedRange をタブから削除します。この方法では、範囲の内容は削除されず、参照のみが削除されます。すでに削除されている NamedRange でこのメソッドを呼び出しても効果はありません。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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