Esta página foi traduzida pela API Cloud Translation.

Class RangeBuilder

Um builder usado para criar objetos Range a partir de elementos de documento.

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

Métodos

Método	Tipo de retorno	Breve descrição
`addElement(element)`	`RangeBuilder`	Adiciona um `Element` inteiro a este `RangeBuilder`.
`addElement(textElement, startOffset, endOffsetInclusive)`	`RangeBuilder`	Adiciona um elemento `Text` parcial a este `RangeBuilder`.
`addElementsBetween(startElement, endElementInclusive)`	`RangeBuilder`	Adiciona dois elementos inteiros e todos os elementos entre eles a este `RangeBuilder`.
`addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)`	`RangeBuilder`	Adiciona dois elementos `Text` parciais e todos os elementos entre eles ao `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[]`	Extrai todos os elementos desse `Range`, incluindo elementos `Text` parciais (por exemplo, no caso de uma seleção que inclui apenas parte de um elemento `Text`).

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`getSelectedElements()`	`RangeElement[]`	Recebe todos os elementos que o usuário selecionou na instância aberta do documento, incluindo elementos `Text` parcialmente selecionados.

Documentação detalhada

`addElement(element)`

Adiciona um Element inteiro a este 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 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 este 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 a ser incluído, ou seja, o índice do último caractere no intervalo

Retornar

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 este 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 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 ao 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 adicionado parcialmente
`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)

Retornar

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 este RangeBuilder.

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O intervalo cujos elementos precisam ser adicionados

Retornar

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()`

Cria um Range com base nas configurações aplicadas ao builder.

Retornar

Range: o intervalo recém-criado

`getRangeElements()`

Extrai todos os elementos desse Range, incluindo elementos Text parciais (por exemplo, no caso de uma seleção que inclui apenas parte de um elemento Text). Para determinar se um 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 exigem autorização com um ou mais dos seguintes escopos:

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

Métodos obsoletos

`getSelectedElements()`

Obsoleto. Renomeado como getRangeElements()

Recebe todos os elementos que o usuário selecionou na instância aberta do documento, incluindo elementos Text parcialmente selecionados.

Retornar

RangeElement[]: uma matriz de elementos selecionados ou parcialmente selecionados, 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