後で取得できるように名前と 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
- 範囲の名前。必ずしも一意ではありません。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRange()
remove()
この NamedRange
をタブから削除します。このメソッドでは、
範囲参照が削除されるだけです。このメソッドを呼び出す NamedRange
は、
すでに削除されていても効果はありません。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents