Class TextRange

TextRange

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

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

Métodos

MétodoTipo de retornoBreve descrição
appendParagraph(text)ParagraphAcrescenta um parágrafo ao final do intervalo de texto.
appendRange(textRange)TextRangeAdiciona uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendRange(textRange, matchSourceFormatting)TextRangeAdiciona uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendText(text)TextRangeAcrescenta texto ao 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 adequado para exibição aos usuários finais.
asString()StringRetorna o texto bruto delimitado por esse intervalo da forma ou célula de tabela associada.
clear()voidLimpa o texto delimitado por esse intervalo.
clear(startOffset, endOffset)voidLimpa o texto delimitado pelos ajustes de início e fim 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, começando pelo deslocamento inicial.
getAutoTexts()AutoText[]Retorna os textos automáticos no intervalo de texto atual.
getEndIndex()IntegerRetorna o índice exclusivo, com base em zero, do último caractere neste 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 no intervalo de texto atual ou que se sobrepõem a ele.
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 com base em zero do 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 e false caso contrário.
replaceAllText(findText, replaceText)IntegerSubstitui todas as instâncias de texto correspondentes ao texto de substituição.
replaceAllText(findText, replaceText, matchCase)IntegerSubstitui todas as instâncias de texto correspondentes ao 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)

Acrescenta um parágrafo ao 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 ao adicionar pelo menos um caractere de nova linha ao redor da string.

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

Parâmetros

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

Retornar

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)

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

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

Parâmetros

NomeTipoDescrição
textRangeTextRangeO intervalo de texto a ser anexado.

Retornar

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)

Adiciona 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 no intervalo de texto fornecido serão substituídos pelos valores renderizados. Além disso, nenhum elemento não textual dentro do intervalo de texto fornecido é anexado.

Parâmetros

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

Retornar

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)

Acrescenta texto ao final do intervalo de texto. O texto mantém o estilo do final do texto atual.

Parâmetros

NomeTipoDescrição
textStringA string a ser anexada.

Retornar

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 adequado para exibição aos usuários finais.

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

Retornar

String: o texto renderizado no intervalo.

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 de tabela associada.

Os elementos AutoText, como números de slides gerados e elementos não textuais no intervalo, são substituídos pelo caractere Unicode U+E907.

Retornar

String: o texto bruto no intervalo.

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 um Shape ou TableCell precisa terminar com uma nova linha, a última nova linha no 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 delimitado pelos ajustes de início e fim no intervalo.

Como o texto precisa terminar com uma nova linha, a nova linha final no texto não é removida, mesmo que esteja coberta pelos intervalos especificados.

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 o tamanho 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 pesquisado. Todas as barras invertidas no padrão precisam ser escapadas.

Retornar

TextRange[]: uma lista de intervalos de texto.

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, começando pelo deslocamento inicial. A pesquisa diferencia maiúsculas de minúsculas.

Parâmetros

NomeTipoDescrição
patternStringO padrão de expressão regular a ser pesquisado. Todas as barras invertidas no padrão precisam ser escapadas.
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.

Retornar

TextRange[]: uma lista de intervalos de texto.

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 no intervalo de texto atual.

Retornar

AutoText[]: uma lista de textos automáticos.

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, com base em zero, do último caractere neste intervalo. Se os índices de início e fim forem iguais, o intervalo será considerado vazio.

Retornar

Integer: o índice final do intervalo.

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.

Retornar

Integer: o número de caracteres neste intervalo.

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 no intervalo de texto atual ou que se sobrepõem a ele.

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

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

Retornar

TextRange[]: uma lista de intervalos de texto.

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.

Retornar

Paragraph[]: uma lista de parágrafos em listas.

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.

Retornar

ListStyle: o estilo de lista do intervalo de texto 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

getParagraphStyle()

Retorna o ParagraphStyle do intervalo de texto atual.

Retornar

ParagraphStyle: o estilo de parágrafo do intervalo de texto 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

getParagraphs()

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

Retornar

Paragraph[]: uma lista de parágrafos.

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 o tamanho 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.

Retornar

TextRange: um novo intervalo de texto.

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 execução de texto é um segmento de texto em que todos os caracteres têm o mesmo estilo.

Cada intervalo retornado tem garantia de abranger apenas uma execução quando é criado. Modificações no texto ou no estilo podem fazer com que ele não represente mais exatamente uma execução.

Retornar

TextRange[]: uma lista de intervalos de texto.

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 com base em zero do primeiro caractere neste intervalo. Se os índices de início e fim forem iguais, o intervalo será considerado vazio.

Retornar

Integer: o índice inicial do intervalo.

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.

Retornar

TextStyle: o estilo do texto do intervalo.

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 ao adicionar pelo menos um caractere de nova linha ao redor da string.

Quando a string de texto fornecida contém caracteres de nova linha (consistindo em 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.
textStringA string a ser inserida.

Retornar

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 corresponde à 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.

Retornar

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 no intervalo de texto fornecido serão substituídos pelos valores renderizados. Além disso, nenhum elemento não textual dentro do intervalo de texto fornecido é inserido.

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, corresponda à formatação do texto de origem. Se false, corresponda à formatação do texto de destino.

Retornar

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.
textStringA string a ser inserida.

Retornar

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 e false caso contrário.

Retornar

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

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 de texto correspondentes ao 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 que vai substituir o texto correspondente.

Retornar

Integer: o número de ocorrências mudou

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 de texto correspondentes ao texto de substituição.

Parâmetros

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

Retornar

Integer: o número de ocorrências mudou

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 o está executando e apenas se ele estiver vinculado à apresentação.

O Page pai do Shape ou do TableCell correspondente é definido como o current page selection. O Shape ou o TableCell é definido 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. 
      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();

      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.

    Retornar

    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