Class NamedRange

BenannterBereich

Eine Range mit einem Namen und einer ID, die einen späteren Abruf ermöglichen. Namen müssen nicht unbedingt eindeutig sein. Mehrere verschiedene Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML. Nachdem ein Tab ein NamedRange hinzugefügt wurde, kann es nicht mehr geändert, sondern nur entfernt werden.

Auf eine NamedRange kann über jedes Script zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie den Bereichsnamen ein eindeutiges Präfix voranstellen. 

// 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());

Methoden

MethodeRückgabetypKurzbeschreibung
getId()StringRuft die ID dieses NamedRange ab.
getName()StringRuft den Namen dieser NamedRange ab.
getRange()RangeRuft den Bereich der Elemente ab, die mit dieser NamedRange verknüpft sind.
remove()voidDadurch wird das NamedRange vom Tab entfernt.

Detaillierte Dokumentation

getId()

Ruft die ID dieses NamedRange ab. Die ID ist innerhalb des Tabs eindeutig.

Rückflug

String: Die ID des Bereichs, die innerhalb des Tabs eindeutig ist.

getName()

Ruft den Namen dieser NamedRange ab. Der Name muss nicht eindeutig sein.

Rückflug

String: Der Name des Bereichs, der nicht unbedingt eindeutig sein muss.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange()

Ruft den Bereich der Elemente ab, die mit dieser NamedRange verknüpft sind.

Rückflug

Range: Der Bereich der Elemente, die mit dem Namen und der ID verknüpft sind.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

remove()

Dadurch wird das NamedRange vom Tab entfernt. Bei dieser Methode wird der Inhalt des Bereichs nicht gelöscht, sondern nur die Referenz entfernt. Wenn diese Methode für eine NamedRange aufgerufen wird, die bereits entfernt wurde, hat dies keine Auswirkungen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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