Class NamedRange

NamedRange

Ein Range mit einem Namen und einer ID, die einen späteren Abruf ermöglichen. Namen sind nicht unbedingt einzigartig sind; können verschiedene Bereiche im selben Tab denselben Namen haben, ähnlich wie ein Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML. Sobald ein NamedRange einem Tab hinzugefügt wurde, kann es nicht mehr geändert, sondern nur entfernt werden.

Ein NamedRange kann von jedem Skript aufgerufen werden, das auf den Tab zugreift. So vermeiden Sie unbeabsichtigte Konflikten zwischen Skripts besteht, sollten Sie Bereichsnamen eine eindeutige Zeichenfolge voranstellen.

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

Methoden

MethodeRückgabetypKurzbeschreibung
getId()StringRuft die ID von diesem NamedRange ab.
getName()StringRuft den Namen dieses NamedRange ab.
getRange()RangeRuft den Bereich der Elemente ab, die mit NamedRange verknüpft sind.
remove()voidEntfernt dieses NamedRange vom Tab.

Detaillierte Dokumentation

getId()

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

Rückflug

String: Die Bereichs-ID, die auf dem Tab eindeutig ist.


getName()

Ruft den Namen dieses NamedRange ab. Der Name ist nicht unbedingt eindeutig.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 NamedRange verknüpft sind.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

remove()

Entfernt dieses NamedRange vom Tab. Bei dieser Methode wird der Inhalt der Bereich; entfernt lediglich der Verweis. Aufruf dieser Methode auf einem NamedRange, der bereits entfernt wurde, hat keine Auswirkungen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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