Class TextRange

TextRange

Es un segmento del contenido de texto de un Shape o un TableCell.

Si usas métodos que editan cómo se ajusta el texto dentro de una forma, se desactivará cualquier configuración de ajuste automático aplicada a la forma.

Métodos

MétodoTipo de datos que se muestraDescripción breve
appendParagraph(text)ParagraphAgrega un párrafo al final del rango de texto.
appendRange(textRange)TextRangeAgrega una copia del rango de texto proporcionado al final del rango de texto actual.
appendRange(textRange, matchSourceFormatting)TextRangeAgrega una copia del rango de texto proporcionado al final del rango de texto actual.
appendText(text)TextRangeAgrega texto al final del rango de texto.
asRenderedString()StringDevuelve el texto renderizado delimitado por este rango de la forma o celda de tabla asociada en un formato adecuado para mostrar a los usuarios finales.
asString()StringDevuelve el texto sin procesar delimitado por este rango de la forma o celda de tabla asociada.
clear()voidBorra el texto delimitado por este rango.
clear(startOffset, endOffset)voidBorra el texto delimitado por las compensaciones inicial y final del rango.
find(pattern)TextRange[]Devuelve todos los rangos que coinciden con el patrón de búsqueda en el rango de texto actual.
find(pattern, startOffset)TextRange[]Devuelve todos los rangos que coinciden con el patrón de búsqueda en el rango de texto actual a partir del desplazamiento inicial.
getAutoTexts()AutoText[]Devuelve los textos automáticos dentro del rango de texto actual.
getEndIndex()IntegerDevuelve el índice exclusivo basado en 0 para el último carácter de este rango.
getLength()IntegerDevuelve la cantidad de caracteres en este rango.
getLinks()TextRange[]Devuelve una colección de rangos de texto que corresponden a todos los Link dentro del rango de texto actual o que se superponen con él.
getListParagraphs()Paragraph[]Devuelve los párrafos en listas que se superponen con el intervalo de texto actual.
getListStyle()ListStyleDevuelve el ListStyle del rango de texto actual.
getParagraphStyle()ParagraphStyleDevuelve el ParagraphStyle del rango de texto actual.
getParagraphs()Paragraph[]Devuelve los párrafos que se superponen con el rango de texto actual.
getRange(startOffset, endOffset)TextRangeDevuelve un nuevo TextRange que abarca parte del rango del que se deriva.
getRuns()TextRange[]Devuelve los tramos de texto que se superponen con el rango de texto actual.
getStartIndex()IntegerDevuelve el índice inclusivo basado en 0 para el primer carácter de este rango.
getTextStyle()TextStyleDevuelve el estilo de texto del rango o null si el rango está vacío.
insertParagraph(startOffset, text)ParagraphInserta un párrafo en el desplazamiento de inicio.
insertRange(startOffset, textRange)TextRangeInserta una copia del rango de texto proporcionado en el desplazamiento inicial.
insertRange(startOffset, textRange, matchSourceFormatting)TextRangeInserta una copia del rango de texto proporcionado en el desplazamiento inicial.
insertText(startOffset, text)TextRangeInserta texto en el desplazamiento de inicio.
isEmpty()BooleanDevuelve true si no hay caracteres en este rango y false en caso contrario.
replaceAllText(findText, replaceText)IntegerReemplaza todas las instancias del texto que coincide con el texto de búsqueda por el texto de reemplazo.
replaceAllText(findText, replaceText, matchCase)IntegerReemplaza todas las instancias del texto que coincide con el texto de búsqueda por el texto de reemplazo.
select()voidSelecciona solo el TextRange en la presentación activa y quita cualquier selección anterior.
setText(newText)TextRangeEstablece el texto delimitado por este rango de la forma o celda de tabla asociada.

Documentación detallada

appendParagraph(text)

Agrega un párrafo al final del rango de texto. El párrafo mantiene el diseño del final del rango de texto actual.

La cadena de texto proporcionada se agrega como un párrafo agregando al menos un carácter de nueva línea circundante a la cadena.

Cuando la cadena de texto proporcionada contiene caracteres de líneas nuevas (por lo tanto, consta de varios párrafos), se devuelve el párrafo final agregado.

Parámetros

NombreTipoDescripción
textStringEs la cadena que se agregará como un párrafo.

Volver

Paragraph: Es el Paragraph agregado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

appendRange(textRange)

Agrega una copia del rango de texto proporcionado al final del rango de texto actual.

El formato del texto insertado coincide con el del texto fuente.

Parámetros

NombreTipoDescripción
textRangeTextRangeEs el rango de texto que se anexará.

Volver

TextRange: Es el rango de texto que representa el texto agregado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

appendRange(textRange, matchSourceFormatting)

Agrega una copia del rango de texto proporcionado al final del rango de texto actual.

Si se configura para que coincida con el formato del texto de destino, los AutoText dentro del rango de texto proporcionado se reemplazan por sus valores renderizados. Además, no se agregan los elementos que no son de texto dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
textRangeTextRangeEs el rango de texto que se anexará.
matchSourceFormattingBooleanSi es true, coincide con el formato del texto de origen; si es false, coincide con el formato del texto de destino.

Volver

TextRange: Es el rango de texto que representa el texto agregado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

appendText(text)

Agrega texto al final del rango de texto. El texto mantiene el estilo del final del texto existente.

Parámetros

NombreTipoDescripción
textStringEs la cadena que se anexará.

Volver

TextRange: Es el rango de texto que representa el texto agregado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asRenderedString()

Devuelve el texto renderizado delimitado por este rango de la forma o celda de tabla asociada en un formato adecuado para mostrar a los usuarios finales.

Los elementos AutoText, como los números de diapositivas generados, se reemplazan por sus valores renderizados. Se omiten los elementos que no son de texto en el rango.

Volver

String: Es el texto renderizado en el rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

asString()

Devuelve el texto sin procesar delimitado por este rango de la forma o celda de tabla asociada.

Los elementos AutoText, como los números de diapositivas generados y los elementos que no son de texto en el rango, se reemplazan por el carácter Unicode U+E907.

Volver

String: Es el texto sin formato del rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

clear()

Borra el texto delimitado por este rango.

Dado que todo el texto de un Shape o TableCell debe terminar en un salto de línea, no se quita el salto de línea final del texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

clear(startOffset, endOffset)

Borra el texto delimitado por las compensaciones inicial y final del rango.

Dado que el texto debe terminar con un salto de línea, el salto de línea final del texto no se quita, incluso si está cubierto por los desplazamientos proporcionados.

Parámetros

NombreTipoDescripción
startOffsetIntegerCantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del rango que se borrará. El desplazamiento inicial debe ser mayor o igual que 0 y menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerCantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usa para determinar el índice final exclusivo del rango que se borrará. El valor de endOffset debe ser igual o mayor que startOffset. endOffset también debe ser menor o igual que la longitud del rango actual.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

find(pattern)

Devuelve todos los rangos que coinciden con el patrón de búsqueda en el rango de texto actual. La búsqueda distingue mayúsculas de minúsculas.

Parámetros

NombreTipoDescripción
patternStringEs el patrón de expresión regular que se buscará. Las barras inversas del patrón deben escaparse.

Volver

TextRange[]: Es una lista de rangos de texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

find(pattern, startOffset)

Devuelve todos los rangos que coinciden con el patrón de búsqueda en el rango de texto actual a partir del desplazamiento inicial. La búsqueda distingue mayúsculas de minúsculas.

Parámetros

NombreTipoDescripción
patternStringEs el patrón de expresión regular que se buscará. Las barras inversas del patrón deben escaparse.
startOffsetIntegerCantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del rango de búsqueda. startOffset también debe ser menor que la longitud del rango actual.

Volver

TextRange[]: Es una lista de rangos de texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getAutoTexts()

Devuelve los textos automáticos dentro del rango de texto actual.

Volver

AutoText[]: Es una lista de textos automáticos.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getEndIndex()

Devuelve el índice exclusivo basado en 0 para el último carácter de este rango. Si los índices de inicio y finalización son iguales, se considera que el rango está vacío.

Volver

Integer: Es el índice final del rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getLength()

Devuelve la cantidad de caracteres en este rango.

Volver

Integer: Es la cantidad de caracteres en este rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Devuelve una colección de rangos de texto que corresponden a todos los Link dentro del rango de texto actual o que se superponen con él.

Se garantiza que cada rango devuelto abarca un vínculo cuando se crea. Las modificaciones de texto pueden hacer que ya no represente exactamente un vínculo.

Se puede acceder a cada Link en los rangos devueltos a través de TextStyle.getLink(). 

// Accesses the first link on a TextRange object.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
const linkTextRange = textRange.getLinks()[0];
const textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink());   // logs 'true'
const link = textStyle.getLink();  // Link object

Volver

TextRange[]: Es una lista de rangos de texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getListParagraphs()

Devuelve los párrafos en listas que se superponen con el intervalo de texto actual.

Volver

Paragraph[]: Es una lista de párrafos en listas.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getListStyle()

Devuelve el ListStyle del rango de texto actual.

Volver

ListStyle: Es el estilo de lista del rango de texto actual.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParagraphStyle()

Devuelve el ParagraphStyle del rango de texto actual.

Volver

ParagraphStyle: Es el estilo de párrafo del rango de texto actual.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParagraphs()

Devuelve los párrafos que se superponen con el rango de texto actual.

Volver

Paragraph[]: Es una lista de párrafos.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRange(startOffset, endOffset)

Devuelve un nuevo TextRange que abarca parte del rango del que se deriva.

Parámetros

NombreTipoDescripción
startOffsetIntegerCantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del rango devuelto. El desplazamiento inicial debe ser mayor o igual que 0 y menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerCantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usa para determinar el índice de fin exclusivo del rango devuelto. El valor de endOffset debe ser igual o mayor que startOffset. endOffset también debe ser menor o igual que la longitud del rango actual.

Volver

TextRange: Es un nuevo rango de texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRuns()

Devuelve los tramos de texto que se superponen con el rango de texto actual. Un tramo de texto es un segmento de texto en el que todos los caracteres tienen el mismo estilo de texto.

Cada rango devuelto solo garantiza abarcar una ejecución cuando se crea. Las modificaciones de texto o estilo pueden hacer que ya no represente exactamente una ejecución.

Volver

TextRange[]: Es una lista de rangos de texto.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getStartIndex()

Devuelve el índice inclusivo basado en 0 para el primer carácter de este rango. Si los índices de inicio y finalización son iguales, se considera que el rango está vacío.

Volver

Integer: Es el índice de inicio del rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTextStyle()

Devuelve el estilo de texto del rango o null si el rango está vacío.

Volver

TextStyle: Es el estilo de texto del rango.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertParagraph(startOffset, text)

Inserta un párrafo en el desplazamiento de inicio. El párrafo mantiene el diseño del rango de texto actual en el desplazamiento inicial.

La cadena de texto proporcionada se inserta como un párrafo agregando al menos un carácter de nueva línea circundante a la cadena.

Cuando la cadena de texto proporcionada contiene caracteres de líneas nuevas (por lo tanto, consta de varios párrafos), se devuelve el párrafo final agregado.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usan para determinar el índice de inicio inclusivo del texto que se insertará.
textStringEs la cadena que se insertará.

Volver

Paragraph: Es el Paragraph insertado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertRange(startOffset, textRange)

Inserta una copia del rango de texto proporcionado en el desplazamiento inicial.

El formato del texto insertado coincide con el del texto fuente.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usan para determinar el índice de inicio inclusivo del texto que se insertará.
textRangeTextRangeEs el rango de texto que se insertará.

Volver

TextRange: Es el rango de texto que representa el texto insertado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertRange(startOffset, textRange, matchSourceFormatting)

Inserta una copia del rango de texto proporcionado en el desplazamiento inicial.

Si se configura para que coincida con el formato del texto de destino, los AutoText dentro del rango de texto proporcionado se reemplazan por sus valores renderizados. Además, no se insertan los elementos que no son de texto dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usan para determinar el índice de inicio inclusivo del texto que se insertará.
textRangeTextRangeEs el rango de texto que se insertará.
matchSourceFormattingBooleanSi es true, coincide con el formato del texto de origen; si es false, coincide con el formato del texto de destino.

Volver

TextRange: Es el rango de texto que representa el texto insertado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertText(startOffset, text)

Inserta texto en el desplazamiento de inicio. El texto mantiene el diseño del texto existente en el desplazamiento inicial.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres posteriores al índice de inicio del rango de texto actual que se usan para determinar el índice de inicio inclusivo del texto que se insertará.
textStringEs la cadena que se insertará.

Volver

TextRange: Es el rango de texto que representa el texto insertado.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isEmpty()

Devuelve true si no hay caracteres en este rango y false en caso contrario.

Volver

Boolean: true si no hay caracteres en este rango y, de lo contrario, devuelve false.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

replaceAllText(findText, replaceText)

Reemplaza todas las instancias del texto que coincide con el texto de búsqueda por el texto de reemplazo. La búsqueda no distingue mayúsculas de minúsculas.

Parámetros

NombreTipoDescripción
findTextStringEs el texto que se buscará.
replaceTextStringEs el texto que reemplazará el texto coincidente.

Volver

Integer: La cantidad de ocurrencias cambió.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

replaceAllText(findText, replaceText, matchCase)

Reemplaza todas las instancias del texto que coincide con el texto de búsqueda por el texto de reemplazo.

Parámetros

NombreTipoDescripción
findTextStringEs el texto que se buscará.
replaceTextStringEs el texto que reemplazará el texto coincidente.
matchCaseBooleanSi es true, la búsqueda distingue mayúsculas de minúsculas; si es false, no las distingue.

Volver

Integer: La cantidad de ocurrencias cambió.

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/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select()

Selecciona solo el TextRange en la presentación activa y quita cualquier selección anterior.

Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta y solo si está vinculada a la presentación.

El Page principal del Shape o el TableCell correspondiente se establece como el current page selection. Shape o TableCell se establece como selected page element.

    El Selection puede ser de dos tipos:
    • 1. Es el rango de texto. Usa select en un TextRange no vacío para seleccionar el rango de los caracteres.
    • 2. Posición del cursor. Usa un TextRange vacío para colocar el cursor en el índice deseado. 
      const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
shape.getText().setText('Hello');
// Range selection: Select the text range "He".
shape.getText().getRange(0, 2).select();
// Cursor selection: Place the cursor after "H" like "H|ello".
shape.getText().getRange(1, 1).select();

      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/presentations.currentonly
      • https://www.googleapis.com/auth/presentations

    setText(newText)

    Establece el texto delimitado por este rango de la forma o celda de tabla asociada. El texto mantiene el estilo del inicio del texto existente.

    Parámetros

    NombreTipoDescripción
    newTextStringEs la cadena que se establecerá como el texto nuevo.

    Volver

    TextRange: Es el rango de texto que representa el texto establecido.

    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/presentations.currentonly
    • https://www.googleapis.com/auth/presentations