Class RangeElement

RangeElement

Un wrapper alrededor de una Element con un posible desplazamiento de inicio y fin. Estos desplazamientos permiten representar un rango de caracteres dentro de un elemento Text en los resultados de la búsqueda, las selecciones de documentos y los rangos con nombre.

Métodos

MétodoTipo de datos que se muestraDescripción breve
getElement()ElementObtiene la Element que corresponde a esta RangeElement.
getEndOffsetInclusive()IntegerObtiene la posición del final de un rango parcial dentro del elemento de rango.
getStartOffset()IntegerObtiene la posición del inicio de un rango parcial dentro del elemento de rango.
isPartial()BooleanDetermina si este elemento de rango cubre todo el elemento o una selección parcial de los caracteres del elemento.

Documentación detallada

getElement()

Obtiene la Element que corresponde a esta RangeElement.

// Log debug information about a range element.
Logger.log('Element type: ' + rangeElement.getElement().getType());
if (rangeElement.isPartial()) {
  Logger.log('The character range begins at ' + rangeElement.getStartOffset());
  Logger.log('The character range ends at ' + rangeElement.getEndOffsetInclusive());
} else {
  Logger.log('The entire range element is included.');
}

Devolvedor

Element: Es el elemento que corresponde a este RangeElement.

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

getEndOffsetInclusive()

Obtiene la posición del final de un rango parcial dentro del elemento de rango. Si el elemento es un elemento Text y isPartial() muestra true, el desplazamiento es la cantidad de caracteres antes del último carácter del rango (es decir, el índice del último carácter del rango); en cualquier otro caso, este método muestra -1.

Devolvedor

Integer: Para elementos Text, la cantidad de caracteres antes del último carácter del rango; para otros elementos, -1.

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

getStartOffset()

Obtiene la posición del inicio de un rango parcial dentro del elemento de rango. Si el elemento es un elemento Text y isPartial() muestra true, el desplazamiento es la cantidad de caracteres antes del inicio del rango (es decir, el índice del primer carácter del rango); en cualquier otro caso, este método muestra -1.

Devolvedor

Integer: Para elementos Text, la cantidad de caracteres antes del comienzo del rango; para otros elementos, -1.

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

isPartial()

Determina si este elemento de rango cubre todo el elemento o una selección parcial de los caracteres del elemento. El comienzo y el final del rango de un elemento de rango parcial se puede determinar con getStartOffset() y getEndOffsetInclusive(), respectivamente.

Devolvedor

Boolean: Es true si el elemento está incluido parcialmente; false si no lo está.

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