Class NamedRange

NamedRange

Identyfikator Range z nazwą i identyfikatorem, które można później pobrać. Nazwy nie muszą być niepowtarzalne. Kilka różnych zakresów w jednym dokumencie może mieć tę samą nazwę, podobnie jak klasa w kodzie HTML. Z kolei identyfikatory są unikalne w obrębie dokumentu, podobnie jak identyfikator w kodzie HTML. Po dodaniu do dokumentu elementu NamedRange nie można go zmodyfikować. Można go tylko usunąć.

Dostęp do NamedRange może uzyskać każdy skrypt uzyskujący dostęp do dokumentu. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów niepowtarzalnego ciągu znaków.

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

Metody

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

Szczegółowa dokumentacja

getId()

Pobiera identyfikator tego elementu (NamedRange). Identyfikator jest unikalny w obrębie dokumentu.

Powroty

String – unikalny identyfikator zakresu, który jest unikalny w dokumencie;


getName()

Pobiera nazwę tego elementu: NamedRange. Nazwa nie musi być niepowtarzalna.

Powroty

String – nazwa zakresu, która nie musi być niepowtarzalna;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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.

Powroty

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

remove()

Usuwa ten element NamedRange z dokumentu. Ta metoda nie usuwa zawartości zakresu, a jedynie odniesienie. Wywołanie tej metody na usuniętym elemencie NamedRange nie przynosi żadnego efektu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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