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é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 o 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 um formato 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 esse intervalo. |
clear(startOffset, endOffset) | void | Limpa 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() | Integer | Retorna o índice exclusivo, baseado em 0, 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 Link s 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() | 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 neste intervalo. |
getTextStyle() | TextStyle | 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 substituição pelo texto de substituição. |
replaceAllText(findText, replaceText, matchCase) | Integer | Substitui todas as instâncias do texto correspondente ao texto de substituição 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)
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
Nome | Tipo | Descrição |
---|---|---|
text | String | A 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
Nome | Tipo | Descrição |
---|---|---|
textRange | TextRange | Intervalo 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
Nome | Tipo | Descrição |
---|---|---|
textRange | TextRange | Intervalo de texto a ser anexado. |
matchSourceFormatting | Boolean | Se 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
Nome | Tipo | Descrição |
---|---|---|
text | String | String 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
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 a duração 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 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 pesquisada. Todas as barras invertidas no padrão precisam ter escape. |
Retorno
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
Nome | Tipo | Descrição |
---|---|---|
pattern | String | O padrão de expressão regular a ser pesquisada. Todas as barras invertidas no padrão precisam ter escape. |
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. |
Retorno
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
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
getLinks()
Retorna uma coleção de intervalos de texto que correspondem a todos os Link
s 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
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
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()
getParagraphStyle()
Retorna o ParagraphStyle
do intervalo de texto atual.
Retorno
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
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 a duração 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. |
Retorno
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
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()
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
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 | String 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
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. |
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
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 , 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
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 | String 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
Nome | Tipo | Descrição |
---|---|---|
findText | String | O texto a ser encontrado. |
replaceText | String | O 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
Nome | Tipo | Descrição |
---|---|---|
findText | String | O texto a ser encontrado. |
replaceText | String | O texto para substituir o texto correspondente. |
matchCase | Boolean | Se 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
.
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
Nome | Tipo | Descrição |
---|---|---|
newText | String | A 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