Class NamedRange

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