Class RangeBuilder

RangeBuilder

Un compilador que se usa para construir objetos Range a partir de 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étodoTipo de datos que se muestraDescripción breve
addElement(element)RangeBuilderAgrega un Element completo a este RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAgrega un elemento Text parcial a este RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAgrega dos elementos enteros, y todos los elementos entre ellos, a este RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAgrega dos elementos Text parciales, y todos los elementos entre ellos, a RangeBuilder.
addRange(range)RangeBuilderAgrega el contenido de otro Range a este RangeBuilder.
build()RangeCrea un Range a partir de la configuración aplicada al compilador.
getRangeElements()RangeElement[]Obtiene todos los elementos en este Range, incluidos los elementos Text parciales (por ejemplo, en el caso de una selección que incluye solo una parte de un elemento Text).

Documentación detallada

addElement(element)

Agrega un Element completo a este RangeBuilder.

Parámetros

NombreTipoDescripción
elementElementel elemento que se agregará

Volver

RangeBuilder: Este compilador, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addElement(textElement, startOffset, endOffsetInclusive)

Agrega un elemento Text parcial a este RangeBuilder.

Parámetros

NombreTipoDescripción
textElementTextel elemento de texto que se agregará parcialmente
startOffsetIntegerla cantidad de caracteres antes del primer carácter que se incluirá (es decir, el índice del primer carácter del rango)
endOffsetInclusiveIntegerLa cantidad de caracteres antes del último carácter que se incluirá (es decir, el índice del último carácter del rango)

Volver

RangeBuilder: Este compilador, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addElementsBetween(startElement, endElementInclusive)

Agrega dos elementos enteros, y todos los elementos entre ellos, a este RangeBuilder.

Parámetros

NombreTipoDescripción
startElementElementel primer elemento que se agregará
endElementInclusiveElementel último elemento que se agregará

Volver

RangeBuilder: Este compilador, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Agrega dos elementos Text parciales, y todos los elementos entre ellos, a RangeBuilder.

Parámetros

NombreTipoDescripción
startTextElementTextel primer elemento de texto que se agregará parcialmente
startOffsetIntegerLa cantidad de caracteres antes del primer carácter de startTextElement que se incluirá (es decir, el índice del primer carácter del rango)
endTextElementInclusiveTextel último elemento de texto que se agregará parcialmente
endOffsetInclusiveIntegerLa cantidad de caracteres antes del último carácter de endTextElementInclusive que se incluirá (es decir, el índice del último carácter del rango)

Volver

RangeBuilder: Este compilador, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addRange(range)

Agrega el contenido de otro Range a este RangeBuilder.

Parámetros

NombreTipoDescripción
rangeRangeel rango cuyos elementos se deben agregar

Volver

RangeBuilder: Este compilador, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

build()

Crea un Range a partir de la configuración aplicada al compilador.

Volver

Range: Es el rango recién construido.


getRangeElements()

Obtiene todos los elementos en este Range, incluidos los elementos Text parciales (por ejemplo, en el caso de una selección que incluye solo una parte de un elemento Text). Para determinar si un elemento Text solo se incluye de forma parcial en el rango, consulta RangeElement.isPartial().

Volver

RangeElement[]: Es un arreglo de elementos, en el orden en que aparecen en el documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Métodos obsoletos