Class TextRange

TextRange

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

Si usas métodos que editan la forma en que el texto se ajusta 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()StringMuestra el texto renderizado limitado por este rango de la forma o la celda de tabla asociada en un formato apropiado para mostrar a los usuarios finales.
asString()StringMuestra el texto sin procesar limitado por este rango de la forma o celda de tabla asociada.
clear()voidBorra el texto limitado por este rango.
clear(startOffset, endOffset)voidBorra el texto limitado por las compensaciones iniciales y finales del rango.
find(pattern)TextRange[]Muestra todos los rangos que coinciden con el patrón de búsqueda en el rango de texto actual.
find(pattern, startOffset)TextRange[]Muestra 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()IntegerMuestra la cantidad de caracteres de este rango.
getLinks()TextRange[]Muestra un conjunto de rangos de texto que corresponden a todos los Link dentro del rango de texto actual o que se superponen con él.
getListParagraphs()Paragraph[]Muestra los párrafos de las 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[]Muestra los párrafos que se superponen con el rango de texto actual.
getRange(startOffset, endOffset)TextRangeMuestra un TextRange nuevo que abarca parte del rango del que se deriva.
getRuns()TextRange[]Muestra los tramos de texto que se superponen con el rango de texto actual.
getStartIndex()IntegerMuestra el índice inclusive basado en 0 para el primer carácter de este rango.
getTextStyle()TextStyleMuestra el estilo de texto del rango o null si el rango está vacío.
insertParagraph(startOffset, text)ParagraphInserta un párrafo en el desplazamiento inicial.
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 inicial.
isEmpty()BooleanMuestra true si no hay caracteres en este rango y false de lo contrario.
replaceAllText(findText, replaceText)IntegerReemplaza todas las instancias de texto que coincidan con el texto de búsqueda por el texto de reemplazo.
replaceAllText(findText, replaceText, matchCase)IntegerReemplaza todas las instancias de texto que coincidan 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 limitado 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 línea nueva a la cadena.

Cuando la cadena de texto proporcionada contiene caracteres de línea nueva (por lo que consta de varios párrafos), se muestra el párrafo final agregado.

Parámetros

NombreTipoDescripción
textStringEs la cadena que se agregará como 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 ámbitos:

  • 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 coincidirá con el del texto de origen.

Parámetros

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

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

  • 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, AutoText dentro del rango de texto proporcionado se reemplaza por sus valores renderizados. Además, no se adjuntan los elementos que no sean de texto dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
textRangeTextRangeEs el rango de texto que se agregará.
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 ámbitos:

  • 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 diseño 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 ámbitos:

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

asRenderedString()

Muestra el texto renderizado limitado por este rango de la forma o la celda de tabla asociada en un formato apropiado para mostrar a los usuarios finales.

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

Volver

String

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

asString()

Muestra el texto sin procesar limitado por este rango de la forma o celda de tabla asociada.

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

Volver

String

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

clear()

Borra el texto limitado por este rango.

Dado que todo el texto de una Shape o TableCell debe finalizar en una línea nueva, no se quita la línea nueva 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 ámbitos:

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

clear(startOffset, endOffset)

Borra el texto limitado por las compensaciones iniciales y finales del rango.

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

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive del rango que se borrará. El desplazamiento inicial debe ser igual o mayor que 0 y menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de finalización exclusivo del rango que se borrará. 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 ámbitos:

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

find(pattern)

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

Parámetros

NombreTipoDescripción
patternStringEs el patrón de expresión regular que se buscará. Se deben escapar las barras diagonales del patrón.

Volver

TextRange[]

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

find(pattern, startOffset)

Muestra 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á. Se deben escapar las barras diagonales del patrón.
startOffsetIntegerEs la cantidad de caracteres que se encuentran después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive del rango que se buscará. startOffset también debe ser menor que la longitud del rango actual.

Volver

TextRange[]

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

getAutoTexts()

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

Volver

AutoText[]

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/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 fin son iguales, se considera que el rango está vacío.

Volver

Integer

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

getLength()

Muestra la cantidad de caracteres de este rango.

Volver

Integer

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

Muestra un conjunto 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 que se muestra abarque 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 de los rangos que se muestran 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[]

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

getListParagraphs()

Muestra los párrafos de las listas que se superponen con el rango de texto actual.

Volver

Paragraph[]

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

getListStyle()

Devuelve el ListStyle del rango de texto actual.

Volver

ListStyle

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

getParagraphStyle()

Devuelve el ParagraphStyle del rango de texto actual.

Volver

ParagraphStyle

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

getParagraphs()

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

Volver

Paragraph[]

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

getRange(startOffset, endOffset)

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

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive del rango que se muestra. El desplazamiento inicial debe ser igual o mayor que 0 y menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerEs la cantidad de caracteres que se encuentran después del índice de inicio del rango de texto actual que se usa para determinar el índice de fin exclusivo del rango que se muestra. endOffset debe ser igual o mayor que startOffset. endOffset también debe ser menor o igual que la longitud del rango actual.

Volver

TextRange

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

getRuns()

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

Se garantiza que cada rango que se muestra abarque solo una ejecución cuando se crea. Las modificaciones de texto o estilo pueden hacer que ya no represente exactamente una ejecución.

Volver

TextRange[]

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

getStartIndex()

Muestra el índice inclusive basado en 0 para el primer carácter de este rango. Si los índices inicial y final son iguales, se considera que el rango está vacío.

Volver

Integer

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

getTextStyle()

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

Volver

TextStyle

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

insertParagraph(startOffset, text)

Inserta un párrafo en el desplazamiento inicial. 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 línea nueva a la cadena.

Cuando la cadena de texto proporcionada contiene caracteres de línea nueva (por lo que consta de varios párrafos), se muestra el párrafo final agregado.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive 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 ámbitos:

  • 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 coincidirá con el del texto de origen.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive 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 ámbitos:

  • 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, AutoText dentro del rango de texto proporcionado se reemplaza por sus valores renderizados. Además, no se insertan los elementos no textuales dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive 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 ámbitos:

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

insertText(startOffset, text)

Inserta texto en el desplazamiento inicial. El texto mantiene el estilo del texto existente en el desplazamiento de inicio.

Parámetros

NombreTipoDescripción
startOffsetIntegerEs la cantidad de caracteres que superan el índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusive 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 ámbitos:

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

isEmpty()

Muestra true si no hay caracteres en este rango y false de lo contrario.

Volver

Boolean

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

replaceAllText(findText, replaceText)

Reemplaza todas las instancias de texto que coincidan 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: Es la cantidad de ocurrencias que cambiaron.

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

replaceAllText(findText, replaceText, matchCase)

Reemplaza todas las instancias de texto que coincidan 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, la búsqueda no distingue mayúsculas de minúsculas.

Volver

Integer: Es la cantidad de ocurrencias que cambiaron.

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/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 superior del Shape o el TableCell correspondiente se establece como current page selection. Shape o TableCell se configura como selected page element.

    Selection puede ser de dos tipos:
    • 1. Intervalo de texto, usa la selección en un TextRange no vacío para seleccionar el intervalo 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 ámbitos:

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

    setText(newText)

    Establece el texto limitado por este rango de la forma o celda de tabla asociada. El texto mantiene el estilo del comienzo 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 ámbitos:

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