後で取得できるように名前と ID を持つ Range。名前は必ずしも一意ではありません。HTML のクラスのように、同じドキュメント内の複数の異なる範囲が同じ名前を持つ場合があります。一方、ID は HTML 内の ID のように、ドキュメント内で一意です。ドキュメントに追加した NamedRange は変更できません。削除するだけです。
NamedRange には、ドキュメントにアクセスするすべてのスクリプトからアクセスできます。スクリプト間で意図しない競合を避けるため、範囲名の前に一意の文字列を付けることを検討してください。
// Create a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
rangeBuilder.addElement(tables[i]);
}
doc.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());
Methods
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
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