Class RangeBuilder

Kreatorzakresów

Builder służący do tworzenia obiektów Range z elementów dokumentu. 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Metody

MetodaZwracany typKrótki opis
addElement(element)RangeBuilderDodaje całą listę Element do tej listy RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderDodaje do tego RangeBuilder częściowy element Text.
addElementsBetween(startElement, endElementInclusive)RangeBuilderDodaje do tego RangeBuilder 2 całe elementy i wszystkie elementy między nimi.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderDo elementu RangeBuilder dodaje 2 częściowe elementy Text oraz wszystkie elementy między nimi.
addRange(range)RangeBuilderDodaje zawartość innej Range do tej RangeBuilder.
build()RangeTworzy Range na podstawie ustawień zastosowanych w kreatorze.
getRangeElements()RangeElement[]Pobiera wszystkie elementy tego elementu Range, w tym elementy częściowe Text (np. w przypadku zaznaczenia obejmującego tylko część elementu Text).

Szczegółowa dokumentacja

addElement(element)

Dodaje całą listę Element do tej listy RangeBuilder.

Parametry

NazwaTypOpis
elementElementelement do dodania;

Powrót

RangeBuilder – ten kreator do łańcuchowania

Autoryzacja

Skrypty, które korzystają 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

addElement(textElement, startOffset, endOffsetInclusive)

Dodaje do tego RangeBuilder częściowy element Text.

Parametry

NazwaTypOpis
textElementTextelement tekstowy, który ma zostać częściowo dodany;
startOffsetIntegerliczba znaków przed pierwszym uwzględnianym znakiem (czyli indeks pierwszego znaku w zakresie);
endOffsetInclusiveIntegerliczba znaków przed ostatnim uwzględnianym znakiem (czyli indeks ostatniego znaku w zakresie);

Powrót

RangeBuilder – ten kreator do łańcuchowania

Autoryzacja

Skrypty, które korzystają 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

addElementsBetween(startElement, endElementInclusive)

Dodaje do tego RangeBuilder 2 całe elementy i wszystkie elementy między nimi.

Parametry

NazwaTypOpis
startElementElementpierwszy element do dodania.
endElementInclusiveElementostatni element do dodania.

Powrót

RangeBuilder – ten kreator do łańcuchowania

Autoryzacja

Skrypty, które korzystają 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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Do elementu RangeBuilder dodaje 2 częściowe elementy Text oraz wszystkie elementy między nimi.

Parametry

NazwaTypOpis
startTextElementTextpierwszy element tekstowy, który ma zostać częściowo dodany;
startOffsetIntegerliczba znaków przed pierwszym znakiem ciągu startTextElement, które mają być uwzględnione (czyli indeks pierwszego znaku w zakresie);
endTextElementInclusiveTextostatni element tekstowy, który ma zostać częściowo dodany.
endOffsetInclusiveIntegerliczba znaków przed ostatnim znakiem ciągu endTextElementInclusive, który ma zostać uwzględniony (czyli indeks ostatniego znaku w zakresie);

Powrót

RangeBuilder – ten kreator do łańcuchowania

Autoryzacja

Skrypty, które korzystają 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

addRange(range)

Dodaje zawartość innej Range do tej RangeBuilder.

Parametry

NazwaTypOpis
rangeRangezakres, którego elementy mają zostać dodane

Powrót

RangeBuilder – ten kreator do łańcuchowania

Autoryzacja

Skrypty, które korzystają 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

build()

Tworzy Range na podstawie ustawień zastosowanych w kreatorze.

Powrót

Range – nowo utworzony zakres

getRangeElements()

Pobiera wszystkie elementy tego elementu Range, w tym elementy częściowe Text (np. w przypadku zaznaczenia obejmującego tylko część elementu Text). Aby sprawdzić, czy element Text jest tylko częściowo uwzględniony w zakresie, zapoznaj się z artykułem RangeElement.isPartial().

Powrót

RangeElement[] – tablica elementów w kolejności, w jakiej występują w dokumencie

Autoryzacja

Skrypty, które korzystają 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

Wycofane metody