Class NamedRange

NamedRange

Eine Range mit einem Namen und einer ID, damit sie später abgerufen werden kann. Namen sind nicht unbedingt eindeutig. Mehrere Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, wie eine ID in HTML. Nachdem ein NamedRange einem Tab hinzugefügt wurde, kann er nicht mehr geändert, sondern nur entfernt werden.

Auf eine NamedRange kann von jedem Skript zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie 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

Methode	Rückgabetyp	Kurzbeschreibung
getId()	String	Ruft die ID dieses NamedRange ab.
getName()	String	Ruft den Namen dieser NamedRange ab.
getRange()	Range	Ruft den Bereich der Elemente ab, die mit diesem NamedRange verknüpft sind.
remove()	void	Entfernt dieses NamedRange aus dem Tab.

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 Tabellenblatts 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

---

remove()

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

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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