Un wrapper alrededor de un Element con un posible desplazamiento de inicio y finalización 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étodo | Tipo de datos que se muestra | Descripción breve |
|---|---|---|
getElement() | Element | Obtiene el Element que corresponde a este RangeElement. |
getEndOffsetInclusive() | Integer | Obtiene la posición del final de un rango parcial dentro del elemento de rango. |
getStartOffset() | Integer | Obtiene la posición del inicio de un rango parcial dentro del elemento de rango. |
isPartial() | Boolean | Determina si este elemento de rango abarca el elemento completo o una selección parcial de los caracteres del elemento. |
Documentación detallada
getElement()
Obtiene el Element que corresponde a este 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.');
}
Volver
Element: 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.
Volver
Integer: para los 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.
Volver
Integer: para los elementos Text, la cantidad de caracteres antes del inicio del rango; en el caso de 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 abarca el elemento completo o una selección parcial de los caracteres del elemento. El comienzo y el final de un rango de elementos de rango parcial se pueden determinar con getStartOffset() y getEndOffsetInclusive(), respectivamente.
Volver
Boolean: true si el elemento se incluye parcialmente; false si no
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