Class TextRange

TextRange

Um segmento do conteúdo de texto de uma Shape ou um TableCell.

Se você usar métodos que editam como o texto se ajusta a uma forma, todas as configurações de ajuste automático aplicadas à forma são desativadas.

Métodos

MétodoTipo de retornoBreve descrição
appendParagraph(text)ParagraphAnexa um parágrafo no final do intervalo de texto.
appendRange(textRange)TextRangeAnexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendRange(textRange, matchSourceFormatting)TextRangeAnexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendText(text)TextRangeAnexa o texto no final do intervalo de texto.
asRenderedString()StringRetorna o texto renderizado delimitado por esse intervalo da forma ou célula da tabela associada em um formato apropriado para exibição aos usuários finais.
asString()StringRetorna o texto bruto delimitado por esse intervalo da forma ou célula da tabela associada.
clear()voidLimpa o texto delimitado por esse intervalo.
clear(startOffset, endOffset)voidLimpa o texto limitado pelos deslocamentos inicial e final no intervalo.
find(pattern)TextRange[]Retorna todos os intervalos que correspondem ao padrão de pesquisa no intervalo de texto atual.
find(pattern, startOffset)TextRange[]Retorna todos os intervalos que correspondem ao padrão de pesquisa no intervalo de texto atual a partir do deslocamento inicial.
getAutoTexts()AutoText[]Retorna os textos automáticos dentro do intervalo de texto atual.
getEndIndex()IntegerRetorna o índice exclusivo, baseado em 0, do último caractere nesse intervalo.
getLength()IntegerRetorna o número de caracteres neste intervalo.
getLinks()TextRange[]Retorna uma coleção de intervalos de texto que correspondem a todos os Links dentro do intervalo de texto atual ou sobreposto ao intervalo de texto atual.
getListParagraphs()Paragraph[]Retorna os parágrafos em listas que se sobrepõem ao intervalo de texto atual.
getListStyle()ListStyleRetorna o ListStyle do intervalo de texto atual.
getParagraphStyle()ParagraphStyleRetorna o ParagraphStyle do intervalo de texto atual.
getParagraphs()Paragraph[]Retorna os parágrafos que se sobrepõem ao intervalo de texto atual.
getRange(startOffset, endOffset)TextRangeRetorna um novo TextRange que abrange parte do intervalo de origem.
getRuns()TextRange[]Retorna as execuções de texto que se sobrepõem ao intervalo de texto atual.
getStartIndex()IntegerRetorna o índice inclusivo baseado em 0 para o primeiro caractere neste intervalo.
getTextStyle()TextStyleRetorna o estilo de texto do intervalo ou null se o intervalo estiver vazio.
insertParagraph(startOffset, text)ParagraphInsere um parágrafo no deslocamento inicial.
insertRange(startOffset, textRange)TextRangeInsere uma cópia do intervalo de texto fornecido no deslocamento inicial.
insertRange(startOffset, textRange, matchSourceFormatting)TextRangeInsere uma cópia do intervalo de texto fornecido no deslocamento inicial.
insertText(startOffset, text)TextRangeInsere texto no deslocamento inicial.
isEmpty()BooleanRetorna true se não houver caracteres nesse intervalo. Caso contrário, retorna false.
replaceAllText(findText, replaceText)IntegerSubstitui todas as instâncias do texto correspondente ao texto de substituição pelo texto de substituição.
replaceAllText(findText, replaceText, matchCase)IntegerSubstitui todas as instâncias do texto correspondente ao texto de substituição pelo texto de substituição.
select()voidSeleciona apenas o TextRange na apresentação ativa e remove qualquer seleção anterior.
setText(newText)TextRangeDefine o texto delimitado por esse intervalo da forma ou célula da tabela associada.

Documentação detalhada

appendParagraph(text)

Anexa um parágrafo no final do intervalo de texto. O parágrafo mantém o estilo do final do intervalo de texto atual.

A string de texto fornecida é anexada como um parágrafo adicionando pelo menos um caractere de nova linha ao redor à string.

Quando a string de texto fornecida contém caracteres de nova linha (com vários parágrafos), o parágrafo final adicionado é retornado.

Parâmetros

NomeTipoDescrição
textStringA string a ser anexada como um parágrafo.

Retorno

Paragraph: o Paragraph anexado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendRange(textRange)

Anexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.

A formatação do texto inserido corresponderá à do texto de origem.

Parâmetros

NomeTipoDescrição
textRangeTextRangeIntervalo de texto a ser anexado.

Retorno

TextRange: o intervalo de texto que representa o texto anexado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendRange(textRange, matchSourceFormatting)

Anexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.

Se definido para corresponder à formatação do texto de destino, AutoText dentro do intervalo de texto fornecido serão substituídos pelos valores renderizados. Além disso, todos os elementos não textuais no intervalo de texto fornecido não serão anexados.

Parâmetros

NomeTipoDescrição
textRangeTextRangeIntervalo de texto a ser anexado.
matchSourceFormattingBooleanSe true, corresponde à formatação do texto de origem. Se false, corresponde à formatação do texto de destino.

Retorno

TextRange: o intervalo de texto que representa o texto anexado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

appendText(text)

Anexa o texto no final do intervalo de texto. O texto mantém o estilo do final do texto atual.

Parâmetros

NomeTipoDescrição
textStringString a ser anexada.

Retorno

TextRange: o intervalo de texto que representa o texto anexado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

asRenderedString()

Retorna o texto renderizado delimitado por esse intervalo da forma ou célula da tabela associada em um formato apropriado para exibição aos usuários finais.

Elementos de AutoText, como números de slide gerados, são substituídos pelos valores renderizados. Todos os elementos não textuais no intervalo serão omitidos.

Retorno

String

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

asString()

Retorna o texto bruto delimitado por esse intervalo da forma ou célula da tabela associada.

Os elementos de texto automático, como números de slide gerados e todos os elementos não textuais no intervalo, são substituídos pelo caractere Unicode U+E907.

Retorno

String

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

clear()

Limpa o texto delimitado por esse intervalo.

Como todo o texto em uma Shape ou TableCell precisa terminar em uma nova linha, a nova linha final do texto não é removida.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

clear(startOffset, endOffset)

Limpa o texto limitado pelos deslocamentos inicial e final no intervalo.

Como o texto precisa terminar em uma nova linha, essa nova linha final não é removida, mesmo que seja coberta pelos deslocamentos fornecidos.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do intervalo a ser limpo. O deslocamento inicial precisa ser igual ou maior que 0 e menor ou igual a endOffset. startOffset também precisa ser menor que a duração do intervalo atual.
endOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice final exclusivo do intervalo a ser limpo. O endOffset precisa ser igual ou maior que startOffset. endOffset também precisa ser menor ou igual ao comprimento do intervalo atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

find(pattern)

Retorna todos os intervalos que correspondem ao padrão de pesquisa no intervalo de texto atual. A pesquisa diferencia maiúsculas de minúsculas.

Parâmetros

NomeTipoDescrição
patternStringO padrão de expressão regular a ser pesquisada. Todas as barras invertidas no padrão precisam ter escape.

Retorno

TextRange[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

find(pattern, startOffset)

Retorna todos os intervalos que correspondem ao padrão de pesquisa no intervalo de texto atual a partir do deslocamento inicial. A pesquisa diferencia maiúsculas de minúsculas.

Parâmetros

NomeTipoDescrição
patternStringO padrão de expressão regular a ser pesquisada. Todas as barras invertidas no padrão precisam ter escape.
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do intervalo a ser pesquisado. startOffset também precisa ser menor que o comprimento do intervalo atual.

Retorno

TextRange[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAutoTexts()

Retorna os textos automáticos dentro do intervalo de texto atual.

Retorno

AutoText[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getEndIndex()

Retorna o índice exclusivo, baseado em 0, do último caractere nesse intervalo. Se os índices inicial e final forem iguais, o intervalo será considerado vazio.

Retorno

Integer

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getLength()

Retorna o número de caracteres neste intervalo.

Retorno

Integer

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

Retorna uma coleção de intervalos de texto que correspondem a todos os Links dentro do intervalo de texto atual ou sobreposto ao intervalo de texto atual.

Cada intervalo retornado abrange um link quando é criado. Modificações de texto podem fazer com que ele não represente mais exatamente um link.

Cada Link nos intervalos retornados pode ser acessado por meio 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

Retorno

TextRange[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getListParagraphs()

Retorna os parágrafos em listas que se sobrepõem ao intervalo de texto atual.

Retorno

Paragraph[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getListStyle()

Retorna o ListStyle do intervalo de texto atual.

Retorno

ListStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getParagraphStyle()

Retorna o ParagraphStyle do intervalo de texto atual.

Retorno

ParagraphStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getParagraphs()

Retorna os parágrafos que se sobrepõem ao intervalo de texto atual.

Retorno

Paragraph[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getRange(startOffset, endOffset)

Retorna um novo TextRange que abrange parte do intervalo de origem.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do intervalo retornado. O deslocamento inicial precisa ser igual ou maior que 0 e menor ou igual a endOffset. startOffset também precisa ser menor que a duração do intervalo atual.
endOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice final exclusivo do intervalo retornado. O endOffset precisa ser igual ou maior que startOffset. endOffset também precisa ser menor ou igual ao comprimento do intervalo atual.

Retorno

TextRange

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getRuns()

Retorna as execuções de texto que se sobrepõem ao intervalo de texto atual. Uma sequência de texto é um segmento de texto em que todos os caracteres têm o mesmo estilo de texto.

Há garantia de que cada intervalo retornado abrangerá apenas uma execução. Modificações de texto ou estilo podem fazer com que ele não represente mais exatamente uma execução.

Retorno

TextRange[]

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getStartIndex()

Retorna o índice inclusivo baseado em 0 para o primeiro caractere neste intervalo. Se os índices inicial e final forem iguais, o intervalo será considerado vazio.

Retorno

Integer

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getTextStyle()

Retorna o estilo de texto do intervalo ou null se o intervalo estiver vazio.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertParagraph(startOffset, text)

Insere um parágrafo no deslocamento inicial. O parágrafo mantém o estilo do intervalo de texto atual no deslocamento inicial.

A string de texto fornecida é inserida como um parágrafo adicionando pelo menos um caractere de nova linha ao redor à string.

Quando a string de texto fornecida contém caracteres de nova linha (com vários parágrafos), o parágrafo final adicionado é retornado.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do texto a ser inserido.
textStringString a ser inserida.

Retorno

Paragraph: o Paragraph inserido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertRange(startOffset, textRange)

Insere uma cópia do intervalo de texto fornecido no deslocamento inicial.

A formatação do texto inserido corresponderá à do texto de origem.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do texto a ser inserido.
textRangeTextRangeO intervalo de texto a ser inserido.

Retorno

TextRange: o intervalo de texto que representa o texto inserido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertRange(startOffset, textRange, matchSourceFormatting)

Insere uma cópia do intervalo de texto fornecido no deslocamento inicial.

Se definido para corresponder à formatação do texto de destino, AutoText dentro do intervalo de texto fornecido serão substituídos pelos valores renderizados. Além disso, elementos não textuais no intervalo de texto fornecido não serão inseridos.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do texto a ser inserido.
textRangeTextRangeO intervalo de texto a ser inserido.
matchSourceFormattingBooleanSe true, corresponde à formatação do texto de origem. Se false, corresponde à formatação do texto de destino.

Retorno

TextRange: o intervalo de texto que representa o texto inserido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

insertText(startOffset, text)

Insere texto no deslocamento inicial. O texto mantém o estilo do texto existente no deslocamento inicial.

Parâmetros

NomeTipoDescrição
startOffsetIntegerO número de caracteres após o índice inicial do intervalo de texto atual usado para determinar o índice inicial inclusivo do texto a ser inserido.
textStringString a ser inserida.

Retorno

TextRange: o intervalo de texto que representa o texto inserido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isEmpty()

Retorna true se não houver caracteres nesse intervalo. Caso contrário, retorna false.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

replaceAllText(findText, replaceText)

Substitui todas as instâncias do texto correspondente ao texto de substituição pelo texto de substituição. A pesquisa não diferencia maiúsculas de minúsculas.

Parâmetros

NomeTipoDescrição
findTextStringO texto a ser encontrado.
replaceTextStringO texto para substituir o texto correspondente.

Retorno

Integer: o número de ocorrências alteradas

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

replaceAllText(findText, replaceText, matchCase)

Substitui todas as instâncias do texto correspondente ao texto de substituição pelo texto de substituição.

Parâmetros

NomeTipoDescrição
findTextStringO texto a ser encontrado.
replaceTextStringO texto para substituir o texto correspondente.
matchCaseBooleanSe true, a pesquisa diferencia maiúsculas de minúsculas. Se false, ela não diferencia maiúsculas de minúsculas.

Retorno

Integer: o número de ocorrências alteradas

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

select()

Seleciona apenas o TextRange na apresentação ativa e remove qualquer seleção anterior.

Um script só pode acessar a seleção do usuário que está executando o script e apenas se ele estiver vinculado à apresentação.

O Page pai da Shape ou da TableCell correspondente é definido como current page selection. A Shape ou a TableCell estão definidas como selected page element.

    O Selection pode ser de dois tipos:
    • 1. Intervalo de texto. Use select em um TextRange não vazio para selecionar o intervalo de caracteres.
    • 2. Posição do cursor, use um TextRange vazio para colocar o cursor no índice desejado.
      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();

      Autorização

      Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

    setText(newText)

    Define o texto delimitado por esse intervalo da forma ou célula da tabela associada. O texto mantém o estilo do início do texto atual.

    Parâmetros

    NomeTipoDescrição
    newTextStringA string a ser definida como o novo texto.

    Retorno

    TextRange: o intervalo de texto que representa o texto definido.

    Autorização

    Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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