Se usó la API de Cloud Translation para traducir esta página.

Class 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étodo	Tipo de datos que se muestra	Descripción breve
`addElement(element)`	`RangeBuilder`	Agrega un `Element` completo a esta `RangeBuilder`.
`addElement(textElement, startOffset, endOffsetInclusive)`	`RangeBuilder`	Agrega un elemento `Text` parcial a este `RangeBuilder`.
`addElementsBetween(startElement, endElementInclusive)`	`RangeBuilder`	Agrega dos elementos completos, y todos los elementos entre ellos, a esta `RangeBuilder`.
`addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)`	`RangeBuilder`	Agrega dos elementos `Text` parciales, y todos los elementos entre ellos, a `RangeBuilder`.
`addRange(range)`	`RangeBuilder`	Agrega el contenido de otra `Range` a esta `RangeBuilder`.
`build()`	`Range`	Construye un `Range` a partir de la configuración que se aplicó al compilador.
`getRangeElements()`	`RangeElement[]`	Obtiene todos los elementos de esta `Range`, incluidos los elementos `Text` parciales (por ejemplo, en el caso de una selección que incluye solo una parte de un elemento `Text`).

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`getSelectedElements()`	`RangeElement[]`	Obtiene todos los elementos que el usuario seleccionó en la instancia abierta del documento, incluidos los elementos `Text` seleccionados parcialmente.

Documentación detallada

`addElement(element)`

Agrega un Element completo a esta RangeBuilder.

Parámetros

Nombre	Tipo	Descripción
`element`	`Element`	el elemento que se agregará

Devolvedor

RangeBuilder: Este compilador se usa 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

Nombre	Tipo	Descripción
`textElement`	`Text`	el elemento de texto que se agregará
`startOffset`	`Integer`	la cantidad de caracteres antes del primer carácter que se incluirá (es decir, el índice del primer carácter del rango)
`endOffsetInclusive`	`Integer`	la cantidad de caracteres antes del último carácter que se incluirá (es decir, el índice del último carácter del rango)

Devolvedor

RangeBuilder: Este compilador se usa 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 completos, y todos los elementos entre ellos, a esta RangeBuilder.

Parámetros

Nombre	Tipo	Descripción
`startElement`	`Element`	el primer elemento que se agregue
`endElementInclusive`	`Element`	el último elemento que se agrega

Devolvedor

RangeBuilder: Este compilador se usa 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

Nombre	Tipo	Descripción
`startTextElement`	`Text`	el primer elemento de texto que se agregará parcialmente
`startOffset`	`Integer`	la cantidad de caracteres antes del primer carácter de `startTextElement` que se incluirá (es decir, el índice del primer carácter del rango)
`endTextElementInclusive`	`Text`	el último elemento de texto que se agregó parcialmente
`endOffsetInclusive`	`Integer`	la cantidad de caracteres antes del último carácter de `endTextElementInclusive` que se incluirá (es decir, el índice del último carácter del rango)

Devolvedor

RangeBuilder: Este compilador se usa 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 otra Range a esta RangeBuilder.

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	el rango a cuyos elementos se deben agregar

Devolvedor

RangeBuilder: Este compilador se usa 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()`

Construye un Range a partir de la configuración que se aplicó al compilador.

Devolvedor

Range: Es el rango recién construido.

`getRangeElements()`

Obtiene todos los elementos de esta 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 parcialmente en el rango, consulta RangeElement.isPartial().

Devolvedor

RangeElement[]: Es un array 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

`getSelectedElements()`

Obsoleto. Se cambió el nombre a getRangeElements()

Obtiene todos los elementos que el usuario seleccionó en la instancia abierta del documento, incluidos los elementos Text seleccionados parcialmente.

Devolvedor

RangeElement[]: Es un array de elementos seleccionados o parcialmente seleccionados, 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