Class TextRange

TextRange

Un segmento del contenido de texto de una Shape o una TableCell.

Si usas métodos que editan la manera en que el texto se ajusta a 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 delimitado por este rango de la forma asociada o la celda de la tabla en un formato adecuado para mostrarse a los usuarios finales.
asString()StringMuestra el texto sin procesar delimitado por este rango de la forma o celda de tabla asociadas.
clear()voidBorra el texto delimitado por este rango.
clear(startOffset, endOffset)voidBorra el texto delimitado por los desplazamientos inicial y final en el 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 de inicio.
getAutoTexts()AutoText[]Muestra los textos automáticos dentro del rango de texto actual.
getEndIndex()IntegerMuestra el índice exclusivo basado en 0 para el último carácter de este rango.
getLength()IntegerMuestra la cantidad de caracteres en este rango.
getLinks()TextRange[]Muestra una colección de rangos de texto que corresponden a todos los elementos Link dentro del rango de texto actual o que se superponen con el rango de texto actual.
getListParagraphs()Paragraph[]Muestra los párrafos de las listas que se superponen con el rango de texto actual.
getListStyle()ListStyleMuestra el ListStyle del rango de texto actual.
getParagraphStyle()ParagraphStyleMuestra 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 las ejecuciones de texto que se superponen con el rango de texto actual.
getStartIndex()IntegerMuestra el índice inclusivo 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, de lo contrario, muestra false.
replaceAllText(findText, replaceText)IntegerReemplaza todas las instancias de texto que coinciden con el texto de búsqueda por reemplazar el texto.
replaceAllText(findText, replaceText, matchCase)IntegerReemplaza todas las instancias de texto que coinciden con el texto de búsqueda por reemplazar el texto.
select()voidSelecciona solo la TextRange en la presentación activa y quita la selección anterior.
setText(newText)TextRangeEstablece el texto delimitado por este rango de la forma o celda de tabla asociadas.

Documentación detallada

appendParagraph(text)

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

Para agregar la cadena de texto proporcionada como un párrafo, agrega al menos un carácter de línea nueva circundante a la cadena.

Cuando la string de texto proporcionada contiene caracteres de salto de línea (que constan de varios párrafos), se muestra el párrafo final agregado.

Parámetros

NombreTipoDescripción
textStringCadena que se agrega como un párrafo.

Devolvedor

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

Parámetros

NombreTipoDescripción
textRangeTextRangeEl rango de texto que se agregará.

Devolvedor

TextRange: 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, las AutoText dentro del rango de texto proporcionado se reemplazan por sus valores renderizados. Además, no se anexa ningún elemento que no sea texto dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
textRangeTextRangeEl 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.

Devolvedor

TextRange: 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
textStringCadena que se agregará.

Devolvedor

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

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()

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

Los elementos de AutoText, como los números de diapositiva generados, se reemplazan por sus valores renderizados. Se omitirá cualquier elemento del rango que no sea de texto.

Devolvedor

String

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()

Muestra el texto sin procesar delimitado por este rango de la forma o celda de tabla asociadas.

Los elementos de AutoText, como los números de diapositiva generados y cualquier elemento no textual del rango, se reemplazan por el carácter Unicode U+E907.

Devolvedor

String

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 una Shape o TableCell debe terminar 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 alcances:

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

clear(startOffset, endOffset)

Borra el texto delimitado por los desplazamientos inicial y final en el rango.

Dado que el texto debe terminar en una línea nueva, la línea nueva final no se quita, incluso si está cubierta por los desplazamientos dados.

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del í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 igual o mayor que 0, así como menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerLa cantidad de caracteres después del í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)

Muestra 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
patternStringEl patrón de expresión regular que se buscará. Se debe escapar cualquier barra inversa del patrón.

Devolvedor

TextRange[]

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)

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

Parámetros

NombreTipoDescripción
patternStringEl patrón de expresión regular que se buscará. Se debe escapar cualquier barra inversa del patrón.
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del rango en el que se buscará. startOffset también debe ser menor que la longitud del rango actual.

Devolvedor

TextRange[]

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()

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

Devolvedor

AutoText[]

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()

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

Devolvedor

Integer

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()

Muestra la cantidad de caracteres en este rango.

Devolvedor

Integer

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

Muestra una colección de rangos de texto que corresponden a todos los elementos Link dentro del rango de texto actual o que se superponen con el rango de texto actual.

Se garantiza que cada rango que se muestra abarca un vínculo cuando se crea. Las modificaciones de texto pueden hacer que deje de representar exactamente un vínculo.

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

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

Devolvedor

TextRange[]

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()

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

Devolvedor

Paragraph[]

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()

Muestra el ListStyle del rango de texto actual.

Devolvedor

ListStyle

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()

Muestra el ParagraphStyle del rango de texto actual.

Devolvedor

ParagraphStyle

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()

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

Devolvedor

Paragraph[]

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)

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

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del rango mostrado. El desplazamiento inicial debe ser igual o mayor que 0, así como menor o igual que endOffset. startOffset también debe ser menor que la longitud del rango actual.
endOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice final exclusivo del rango mostrado. 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.

Devolvedor

TextRange

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()

Muestra las ejecuciones de texto que se superponen con el rango de texto actual. Una ejecución de texto es un segmento de texto en el que todos los caracteres tienen el mismo estilo de texto.

Cuando se crea, se garantiza que cada rango que se muestra solo abarque una ejecución. Las modificaciones de texto o estilo pueden hacer que deje de representar exactamente una ejecución.

Devolvedor

TextRange[]

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()

Muestra el índice inclusivo 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.

Devolvedor

Integer

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()

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

Devolvedor

TextStyle

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 inicial. El párrafo mantiene el estilo del rango de texto actual en el desplazamiento inicial.

Para insertar la cadena de texto proporcionada como un párrafo, agrega al menos un carácter de línea nueva circundante a la cadena.

Cuando la string de texto proporcionada contiene caracteres de salto de línea (que constan de varios párrafos), se muestra el párrafo final agregado.

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del texto que se insertará.
textStringCadena que se va a insertar

Devolvedor

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

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del texto que se insertará.
textRangeTextRangeEl rango de texto que se insertará.

Devolvedor

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, las AutoText dentro del rango de texto proporcionado se reemplazan por sus valores renderizados. Además, no se insertará ningún elemento que no sea texto dentro del rango de texto proporcionado.

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del texto que se insertará.
textRangeTextRangeEl 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.

Devolvedor

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 inicial. El texto mantiene el estilo del texto existente en el desplazamiento inicial.

Parámetros

NombreTipoDescripción
startOffsetIntegerLa cantidad de caracteres después del índice de inicio del rango de texto actual que se usa para determinar el índice de inicio inclusivo del texto que se insertará.
textStringCadena que se va a insertar

Devolvedor

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()

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

Devolvedor

Boolean

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 de texto que coinciden con el texto de búsqueda por reemplazar el texto. La búsqueda no distingue mayúsculas de minúsculas.

Parámetros

NombreTipoDescripción
findTextStringEl texto a buscar.
replaceTextStringTexto que reemplazará el texto coincidente.

Devolvedor

Integer: Se modificó la cantidad de repeticiones.

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 de texto que coinciden con el texto de búsqueda por reemplazar el texto.

Parámetros

NombreTipoDescripción
findTextStringEl texto a buscar.
replaceTextStringTexto que reemplazará el texto coincidente.
matchCaseBooleanSi es true, la búsqueda distingue mayúsculas de minúsculas. Si es false, no lo hace.

Devolvedor

Integer: Se modificó la cantidad de repeticiones.

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 la TextRange en la presentación activa y quita la selección anterior.

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

El Page superior del Shape o TableCell correspondiente se establece como current page selection. El Shape o la TableCell se configuran como selected page element.

    Selection puede ser de dos tipos:
    • 1. Rango de texto; usa {i>select<i} en un TextRange que no esté vacío para seleccionar el rango de caracteres.
    • 2. Posición del cursor, usa un TextRange vacío para colocar el cursor en el índice deseado.
      var 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 asociadas. El texto mantiene el estilo del comienzo del texto existente.

    Parámetros

    NombreTipoDescripción
    newTextStringCadena que se va a establecer como texto nuevo

    Devolvedor

    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