Class RangeBuilder

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étodoTipo de retornoBreve descrição
addElement(element)RangeBuilderAdiciona um Element inteiro a este RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAdiciona um elemento Text parcial a este RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAdiciona dois elementos inteiros e todos os elementos entre eles a este RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAdiciona dois elementos Text parciais e todos os elementos entre eles ao RangeBuilder.
addRange(range)RangeBuilderAdiciona o conteúdo de outro Range a este RangeBuilder.
build()RangeCria 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).

Documentação detalhada

addElement(element)

Adiciona um Element inteiro a este RangeBuilder.

Parâmetros

NomeTipoDescrição
elementElemento 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

NomeTipoDescrição
textElementTexto elemento de texto a ser adicionado parcialmente
startOffsetIntegero número de caracteres antes do primeiro caractere a ser incluído (ou seja, o índice do primeiro caractere no intervalo)
endOffsetInclusiveIntegero 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

NomeTipoDescrição
startElementElemento primeiro elemento a ser adicionado
endElementInclusiveElemento ú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

NomeTipoDescrição
startTextElementTexto primeiro elemento de texto a ser adicionado parcialmente
startOffsetIntegero número de caracteres antes do primeiro caractere de startTextElement a ser incluído (ou seja, o índice do primeiro caractere no intervalo)
endTextElementInclusiveTexto último elemento de texto a ser adicionado parcialmente
endOffsetInclusiveIntegero 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

NomeTipoDescrição
rangeRangeO 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