Ein Range mit einem Namen und einer ID, die später abgerufen werden kann. Namen sind nicht unbedingt eindeutig. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML. Sobald ein NamedRange zu einem Dokument hinzugefügt wurde, kann er nicht mehr geändert, sondern nur entfernt werden.
Ein NamedRange kann von jedem Skript aufgerufen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String als Präfix hinzufügen.
// 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());
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
getId() | String | Ruft die ID dieses NamedRange ab. |
getName() | String | Ruft den Namen dieses NamedRange ab. |
getRange() | Range | Ruft den Bereich der Elemente ab, die mit diesem NamedRange verknüpft sind. |
remove() | void | Entfernt dieses Element (NamedRange) aus dem Dokument. |
Detaillierte Dokumentation
getId()
Ruft die ID dieses NamedRange ab. Die ID ist innerhalb des Dokuments eindeutig.
Return
String: Die ID des Bereichs, die innerhalb des Dokuments eindeutig ist.
getName()
Ruft den Namen dieses NamedRange ab. Der Name ist nicht unbedingt eindeutig.
Return
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 diesem NamedRange verknüpft sind.
Return
Range: der mit dem Namen und der ID verknüpfte Elementbereich
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 Element (NamedRange) aus dem Dokument. Mit dieser Methode wird nicht der Inhalt des Bereichs gelöscht. Es wird lediglich der Verweis entfernt. Der Aufruf dieser Methode für ein NamedRange, das 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