Um builder usado para construir objetos Range com base em elementos do documento.
// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
addElement(element) | RangeBuilder | Adiciona um Element inteiro a esse RangeBuilder. |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Adiciona um elemento Text parcial a esse RangeBuilder. |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Adiciona dois elementos inteiros e todos os elementos entre eles a essa RangeBuilder. |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Adiciona dois elementos Text parciais e todos os elementos entre eles à RangeBuilder. |
addRange(range) | RangeBuilder | Adiciona o conteúdo de outro Range a este RangeBuilder. |
build() | Range | Cria um Range com base nas configurações aplicadas ao builder. |
getRangeElements() | RangeElement[] | Recebe todos os elementos nesse Range, incluindo qualquer elemento Text parcial (por exemplo, no caso
de uma seleção que inclui apenas parte de um elemento Text). |
Documentação detalhada
addElement(element)
Adiciona um Element inteiro a esse RangeBuilder.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
element | Element | o elemento a ser adicionado |
Retornar
RangeBuilder: este builder para encadeamento
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
Adiciona um elemento Text parcial a esse RangeBuilder.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
textElement | Text | o elemento de texto a ser parcialmente adicionado |
startOffset | Integer | o número de caracteres antes do primeiro a ser incluído (ou seja, o índice do primeiro caractere do intervalo) |
endOffsetInclusive | Integer | o número de caracteres antes do último caractere a ser incluído (ou seja, o índice do último caractere do intervalo) |
Retornar
RangeBuilder: este builder para encadeamento
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
Adiciona dois elementos inteiros e todos os elementos entre eles a essa RangeBuilder.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
startElement | Element | o primeiro elemento a ser adicionado |
endElementInclusive | Element | o último elemento a ser adicionado |
Retornar
RangeBuilder: este builder para encadeamento
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
Adiciona dois elementos Text parciais e todos os elementos entre eles à RangeBuilder.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
startTextElement | Text | o primeiro elemento de texto a ser parcialmente adicionado |
startOffset | Integer | o número de caracteres antes do primeiro caractere de startTextElement a serem incluídos (ou seja, o índice do primeiro caractere no intervalo) |
endTextElementInclusive | Text | o último elemento de texto a ser parcialmente adicionado |
endOffsetInclusive | Integer | o número de caracteres antes do último caractere de endTextElementInclusive a ser incluído (ou seja, o índice do último caractere na
período) |
Retornar
RangeBuilder: este builder para encadeamento
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
addRange(range)
Adiciona o conteúdo de outro Range a este RangeBuilder.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
range | Range | o intervalo cujos elementos devem ser adicionados |
Retornar
RangeBuilder: este builder para encadeamento
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
build()
Cria um Range com base nas configurações aplicadas ao builder.
Retornar
Range: o intervalo recém-construído
getRangeElements()
Recebe todos os elementos nesse Range, incluindo qualquer elemento Text parcial (por exemplo, no caso
de uma seleção que inclui apenas parte de um elemento Text). Para determinar se um
O elemento Text está incluído apenas parcialmente no intervalo. Consulte RangeElement.isPartial().
Retornar
RangeElement[]: uma matriz de elementos, na ordem em que aparecem no documento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents