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 a ela serão desativadas.

Métodos

Método	Tipo de retorno	Breve descrição
appendParagraph(text)	Paragraph	Acrescenta um parágrafo ao final do intervalo de texto.
appendRange(textRange)	TextRange	Adiciona uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendRange(textRange, matchSourceFormatting)	TextRange	Adiciona uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendText(text)	TextRange	Acrescenta texto ao final do intervalo de texto.
asRenderedString()	String	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.
asString()	String	Retorna o texto bruto delimitado por esse intervalo da forma ou célula de tabela associada.
clear()	void	Limpa o texto delimitado por esse intervalo.
clear(startOffset, endOffset)	void	Limpa o texto delimitado pelos ajustes de início e fim no intervalo.
find(pattern)	TextRange[]	Retorna todos os intervalos que correspondem ao padrão das pesquisas no intervalo de texto atual.
find(pattern, startOffset)	TextRange[]	Retorna todos os intervalos que correspondem ao padrão das pesquisas no intervalo de texto atual, começando pelo deslocamento inicial.
getAutoTexts()	AutoText[]	Retorna os textos automáticos no intervalo de texto atual.
getEndIndex()	Integer	Retorna o índice exclusivo, baseado em zero, do último caractere nesse intervalo.
getLength()	Integer	Retorna 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()	ListStyle	Retorna o ListStyle do intervalo de texto atual.
getParagraphStyle()	ParagraphStyle	Retorna 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)	TextRange	Retorna 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()	Integer	Retorna o índice inclusivo, com base em zero, do primeiro caractere neste intervalo.
getTextStyle()	TextStyle|null	Retorna o estilo de texto do intervalo ou null se o intervalo estiver vazio.
insertParagraph(startOffset, text)	Paragraph	Insere um parágrafo no deslocamento inicial.
insertRange(startOffset, textRange)	TextRange	Insere uma cópia do intervalo de texto fornecido no deslocamento inicial.
insertRange(startOffset, textRange, matchSourceFormatting)	TextRange	Insere uma cópia do intervalo de texto fornecido no deslocamento inicial.
insertText(startOffset, text)	TextRange	Insere texto no deslocamento inicial.
isEmpty()	Boolean	Retorna true se não houver caracteres nesse intervalo. Caso contrário, retorna false.
replaceAllText(findText, replaceText)	Integer	Substitui todas as instâncias do texto correspondente ao texto de pesquisa pelo texto de substituição.
replaceAllText(findText, replaceText, matchCase)	Integer	Substitui todas as instâncias do texto correspondente ao texto de pesquisa pelo texto de substituição.
select()	void	Seleciona apenas o TextRange na apresentação ativa e remove qualquer seleção anterior.
setText(newText)	TextRange	Define 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

Nome	Tipo	Descrição
text	String	A string a ser adicionada ao final 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

Nome	Tipo	Descrição
textRange	TextRange	O 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

Nome	Tipo	Descrição
textRange	TextRange	O intervalo de texto a ser anexado.
matchSourceFormatting	Boolean	Se 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

Nome	Tipo	Descrição
text	String	A string a ser adicionada ao final.

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 texto automático, 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 de texto automático, 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 em uma nova linha, a nova linha final 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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
endOffset	Integer	O 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 das pesquisas no intervalo de texto atual. A pesquisa diferencia maiúsculas de minúsculas.

Parâmetros

Nome	Tipo	Descrição
pattern	String	O 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 das pesquisas no intervalo de texto atual, começando pelo deslocamento inicial. A pesquisa diferencia maiúsculas de minúsculas.

Parâmetros

Nome	Tipo	Descrição
pattern	String	O padrão de expressão regular a ser pesquisado. Todas as barras invertidas no padrão precisam ser escapadas.
startOffset	Integer	O 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, baseado em zero, do último caractere nesse 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

---

getLinks()

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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
endOffset	Integer	O 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 extensã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|null: 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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
text	String	A 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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
textRange	TextRange	O 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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
textRange	TextRange	O intervalo de texto a ser inserido.
matchSourceFormatting	Boolean	Se 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

Nome	Tipo	Descrição
startOffset	Integer	O 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.
text	String	A 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. Caso contrário, retorna false.

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 do texto correspondente ao texto de pesquisa pelo texto de substituição. A pesquisa não diferencia maiúsculas de minúsculas.

Parâmetros

Nome	Tipo	Descrição
findText	String	O texto a ser encontrado.
replaceText	String	O 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 do texto correspondente ao texto de pesquisa pelo texto de substituição.

Parâmetros

Nome	Tipo	Descrição
findText	String	O texto a ser encontrado.
replaceText	String	O texto que vai substituir o texto correspondente.
matchCase	Boolean	Se 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 o 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

Nome	Tipo	Descrição
newText	String	A 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