Class TextRange

TextRange

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

Se você usar métodos que editam como o texto se encaixa em uma forma, as configurações de ajuste automático aplicadas a a forma sejam desativados.

Métodos

Método	Tipo de retorno	Breve descrição
appendParagraph(text)	Paragraph	Anexa um parágrafo no final do intervalo de texto.
appendRange(textRange)	TextRange	Anexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendRange(textRange, matchSourceFormatting)	TextRange	Anexa uma cópia do intervalo de texto fornecido ao final do intervalo de texto atual.
appendText(text)	TextRange	Anexa texto no final do intervalo de texto.
asRenderedString()	String	Retorna o texto renderizado delimitado por esse intervalo da forma ou célula da tabela associada em uma apropriado para exibição aos usuários finais.
asString()	String	Retorna o texto bruto delimitado por esse intervalo da forma ou célula da tabela associada.
clear()	void	Limpa o texto delimitado por este intervalo.
clear(startOffset, endOffset)	void	Limpa o texto delimitado 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, começando pelo deslocamento inicial.
getAutoTexts()	AutoText[]	Retorna os textos automáticos dentro do intervalo de texto atual.
getEndIndex()	Integer	Retorna o índice exclusivo baseado em zero para o último caractere nesse intervalo.
getLength()	Integer	Retorna o número de caracteres nesse intervalo.
getLinks()	TextRange[]	Retorna uma coleção de intervalos de texto que correspondem a todos os Links no atual intervalo de texto ou sobrepondo o intervalo de texto atual.
getListParagraphs()	Paragraph[]	Retorna os parágrafos das 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 baseado em 0 para o primeiro caractere nesse intervalo.
getTextStyle()	TextStyle	Retorna o estilo de texto do intervalo ou null se ele 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 e retorna false. caso contrário.
replaceAllText(findText, replaceText)	Integer	Substitui todas as ocorrências de texto correspondente a localizar texto pelo texto de substituição.
replaceAllText(findText, replaceText, matchCase)	Integer	Substitui todas as ocorrências de texto correspondente a localizar texto pelo texto de substituição.
select()	void	Seleciona apenas o TextRange na apresentação ativa e remove os itens anteriores
setText(newText)	TextRange	Define 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 da fim do intervalo de texto atual.

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

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

Parâmetros

Nome	Tipo	Descrição
text	String	A string a ser anexada como um parágrafo.

Retornar

Paragraph: o Paragraph anexado.

Autorização

Os scripts que usam esse método precisam de 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 corresponde à formatação 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 precisam de 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 definida para corresponder à formatação do texto de destino, AutoText no intervalo de texto são substituídos por seus valores renderizados. Além disso, todos os elementos não textuais o intervalo de texto fornecido não serão anexados.

Parâmetros

Nome	Tipo	Descrição
textRange	TextRange	O intervalo de texto a ser anexado.
matchSourceFormatting	Boolean	Se for true, use a mesma formatação do texto de origem. se false, correspondem à 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 precisam de 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 texto no final do intervalo de texto. O texto mantém o estilo do final da o texto existente.

Parâmetros

Nome	Tipo	Descrição
text	String	A string que será anexada.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 uma apropriado para exibição aos usuários finais.

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

Retornar

String

Autorização

Os scripts que usam esse método precisam de 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.

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

Retornar

String

Autorização

Os scripts que usam esse método precisam de 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 este intervalo.

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

Autorização

Os scripts que usam esse método precisam de 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 deslocamentos inicial e final no intervalo.

Como o texto deve terminar em uma nova linha, a nova linha final no texto não é removida, mesmo que seja cobertos pelos deslocamentos especificados.

Parâmetros

Nome	Tipo	Descrição
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual 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 comprimento do intervalo atual.
endOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual 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 que ou igual ao comprimento do intervalo atual.

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
pattern	String	O padrão de expressão regular a ser pesquisado. todas as barras invertidas do padrão devem do código de escape.

Retornar

TextRange[]

Autorização

Os scripts que usam esse método precisam de 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

Nome	Tipo	Descrição
pattern	String	O padrão de expressão regular a ser pesquisado. todas as barras invertidas do padrão devem do código de escape.
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual para determinar o índice inicial inclusivo do intervalo a ser pesquisado. startOffset precisa também será menor que o comprimento do intervalo atual.

Retornar

TextRange[]

Autorização

Os scripts que usam esse método precisam de 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.

Retornar

AutoText[]

Autorização

Os scripts que usam esse método precisam de 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 para o último caractere nesse intervalo. Se os valores de início e fim índices forem iguais, o intervalo será considerado vazio.

Retornar

Integer

Autorização

Os scripts que usam esse método precisam de 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 nesse intervalo.

Retornar

Integer

Autorização

Os scripts que usam esse método precisam de 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 atual intervalo de texto ou sobrepondo o intervalo de texto atual.

Cada intervalo retornado tem a garantia de abranger um link quando é criado. Modificações de texto pode 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.
var linkTextRange = textRange.getLinks()[0];
var textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink()); // logs 'true'
var link = textStyle.getLink();  // Link object

Retornar

TextRange[]

Autorização

Os scripts que usam esse método precisam de 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 das listas que se sobrepõem ao intervalo de texto atual.

Retornar

Paragraph[]

Autorização

Os scripts que usam esse método precisam de 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

Autorização

Os scripts que usam esse método precisam de 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

Autorização

Os scripts que usam esse método precisam de 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[]

Autorização

Os scripts que usam esse método precisam de 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 usados depois do índice inicial do intervalo de texto atual 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 comprimento do intervalo atual.
endOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual para determinar o índice final exclusivo do intervalo retornado. O endOffset precisa ser igual ou maior que startOffset. endOffset também precisa ser menor que ou igual ao comprimento do intervalo atual.

Retornar

TextRange

Autorização

Os scripts que usam esse método precisam de 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 em que todos os caracteres têm o mesmo estilo de texto.

Cada intervalo retornado só tem a garantia de abranger uma execução quando é criado. Texto ou estilo modificações podem fazer com que ele não represente mais exatamente uma execução.

Retornar

TextRange[]

Autorização

Os scripts que usam esse método precisam de 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 nesse intervalo. Se o início e índices finais forem iguais, o intervalo será considerado vazio.

Retornar

Integer

Autorização

Os scripts que usam esse método precisam de 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 ele estiver vazio.

Retornar

TextStyle

Autorização

Os scripts que usam esse método precisam de 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 da versão atual intervalo de texto no deslocamento inicial.

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

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

Parâmetros

Nome	Tipo	Descrição
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual 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 precisam de 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 à formatação do texto de origem.

Parâmetros

Nome	Tipo	Descrição
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual para determinar o índice inicial inclusivo do texto a ser inserido.
textRange	TextRange	O intervalo de texto a ser inserido.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 definida para corresponder à formatação do texto de destino, AutoText no intervalo de texto são substituídos por seus valores renderizados. Além disso, todos os elementos não textuais o intervalo de texto fornecido não são inseridos.

Parâmetros

Nome	Tipo	Descrição
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual para determinar o índice inicial inclusivo do texto a ser inserido.
textRange	TextRange	O intervalo de texto a ser inserido.
matchSourceFormatting	Boolean	Se for true, use a mesma formatação do texto de origem. se false, correspondem à formatação do texto de destino.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 na deslocamento inicial.

Parâmetros

Nome	Tipo	Descrição
startOffset	Integer	O número de caracteres usados depois do índice inicial do intervalo de texto atual para determinar o índice inicial inclusivo do texto a ser inserido.
text	String	A string a ser inserida.

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 retorna false. caso contrário.

Retornar

Boolean

Autorização

Os scripts que usam esse método precisam de 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 correspondente a localizar texto pelo texto de substituição. A pesquisa é caso insensíveis.

Parâmetros

Nome	Tipo	Descrição
findText	String	O texto a ser encontrado.
replaceText	String	O texto que substituirá o texto correspondente.

Retornar

Integer: o número de ocorrências alterado

Autorização

Os scripts que usam esse método precisam de 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 correspondente a localizar texto pelo texto de substituição.

Parâmetros

Nome	Tipo	Descrição
findText	String	O texto a ser encontrado.
replaceText	String	O texto que substituirá o texto correspondente.
matchCase	Boolean	Se for true, a pesquisa diferencia maiúsculas de minúsculas. se for false, a pesquisa será são indiferentes a maiúsculas.

Retornar

Integer: o número de ocorrências alterado

Autorização

Os scripts que usam esse método precisam de 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 os itens anteriores

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

O Page pai do Shape correspondente ou a TableCell está definido como 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 do 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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