Um builder usado para criar objetos Range
com elementos de documentos.
// Change the user's selection to a 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.setSelection(rangeBuilder.build());
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addElement(element) | RangeBuilder | Adiciona uma Element inteira a essa 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 esse RangeBuilder . |
build() | Range | Cria um Range das configurações aplicadas ao builder. |
getRangeElements() | RangeElement[] | Recebe todos os elementos nesse Range , incluindo todos os elementos Text parciais (por exemplo, no caso
de uma seleção que inclua apenas parte de um elemento Text ). |
Documentação detalhada
addElement(element)
Adiciona uma Element
inteira a essa RangeBuilder
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
element | Element | o elemento a ser adicionado |
Retorno
RangeBuilder
: este builder, para encadeamento
Autorização
Os scripts que usam esse método exigem 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 adicionado parcialmente |
startOffset | Integer | o número de caracteres antes do primeiro caractere a ser incluído (ou seja, o índice do primeiro caractere no intervalo) |
endOffsetInclusive | Integer | o número de caracteres antes do último caractere a ser incluído (ou seja, o índice do último caractere no intervalo) |
Retorno
RangeBuilder
: este builder, para encadeamento
Autorização
Os scripts que usam esse método exigem 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 |
Retorno
RangeBuilder
: este builder, para encadeamento
Autorização
Os scripts que usam esse método exigem 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 adicionado parcialmente |
startOffset | Integer | o número de caracteres antes do primeiro caractere de startTextElement a ser incluído (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 no intervalo) |
Retorno
RangeBuilder
: este builder, para encadeamento
Autorização
Os scripts que usam esse método exigem 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 esse RangeBuilder
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | o intervalo cujos elementos devem ser adicionados |
Retorno
RangeBuilder
: este builder, para encadeamento
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
getRangeElements()
Recebe todos os elementos nesse Range
, incluindo todos os elementos Text
parciais (por exemplo, no caso
de uma seleção que inclua apenas parte de um elemento Text
). Para determinar se um
elemento Text
foi incluído apenas parcialmente no intervalo, consulte RangeElement.isPartial()
.
Retorno
RangeElement[]
: uma matriz de elementos na ordem em que aparecem no documento
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents