Class RangeElement

Elemento de rango

Un wrapper alrededor de un Element con un posible desplazamiento inicial y final. Estos desfases permiten que un rango de caracteres dentro de un elemento Text se represente en los resultados de la búsqueda, las selecciones de documentos y los rangos nombrados.

Métodos

MétodoTipo de datos que se muestraDescripción breve
getElement()ElementObtiene el Element que corresponde a este 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 abarca todo el elemento o una selección parcial de los caracteres del elemento.

Documentación detallada

getElement()

Obtiene el Element que corresponde a este RangeElement. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// 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: 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 ámbitos:

  • 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, la compensación 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, es la cantidad de caracteres antes del último carácter del rango. Para otros elementos, es -1.

Autorización

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

  • 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, la compensación 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, es la cantidad de caracteres antes del comienzo del rango. Para otros elementos, es -1.

Autorización

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

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

isPartial()

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

Volver

Boolean: true si el elemento se incluye de forma parcial; 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 ámbitos:

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