Class NamedRange

NamedRange

Range, która ma nazwę i identyfikator, aby można było ją później odzyskać. Nazwy nie muszą być unikalne. Kilka różnych zakresów na tej samej karcie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w obrębie karty, podobnie jak identyfikator w HTML-u. Po dodaniu NamedRange do karty nie można go zmodyfikować, a jedynie usunąć.

Do NamedRange może uzyskać dostęp każdy skrypt, który ma dostęp do karty. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków. 

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

Metody

MetodaZwracany typKrótki opis
getId()StringPobiera identyfikator tego NamedRange.
getName()StringPobiera nazwę tego NamedRange.
getRange()RangePobiera zakres elementów powiązanych z tym NamedRange.
remove()voidUsuwa kartę NamedRange.

Szczegółowa dokumentacja

getId()

Pobiera identyfikator tego NamedRange. Identyfikator jest unikalny w obrębie karty.

Powrót

String – identyfikator zakresu, który jest unikalny w obrębie karty.

getName()

Pobiera nazwę tego NamedRange. Nazwa nie musi być unikalna.

Powrót

String – nazwa zakresu, która nie musi być unikalna.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getRange()

Pobiera zakres elementów powiązanych z tym NamedRange.

Powrót

Range – zakres elementów powiązanych z nazwą i identyfikatorem.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

remove()

Usuwa kartę NamedRange. Ta metoda nie usuwa zawartości zakresu, tylko odwołanie do niego. Wywołanie tej metody w przypadku elementu NamedRange, który został już usunięty, nie ma żadnego efektu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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