Class TextFinder

TextFinder

Encontrar ou substituir texto em um intervalo, uma página ou uma planilha. Também é possível especificar opções de pesquisa.

Métodos

MétodoTipo de retornoBreve descrição
findAll()Range[]Retorna todas as células que correspondem aos critérios de pesquisa.
findNext()RangeRetorna a próxima célula que corresponde aos critérios de pesquisa.
findPrevious()RangeRetorna a célula anterior que corresponde aos critérios de pesquisa.
getCurrentMatch()RangeRetorna a célula atual que corresponde aos critérios de pesquisa.
ignoreDiacritics(ignoreDiacritics)TextFinderSe true, a pesquisa será configurada para ignorar acentos ao fazer a correspondência. Caso contrário, a pesquisa vai corresponder a acentos.
matchCase(matchCase)TextFinderSe true, configura a pesquisa para corresponder exatamente ao uso de maiúsculas e minúsculas do texto de pesquisa. Caso contrário, a pesquisa usa a correspondência sem diferenciação de maiúsculas e minúsculas por padrão.
matchEntireCell(matchEntireCell)TextFinderSe true, configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usa a correspondência parcial por padrão.
matchFormulaText(matchFormulaText)TextFinderSe true, configura a pesquisa para retornar correspondências que aparecem no texto da fórmula. Caso contrário, as células com fórmulas são consideradas com base no valor mostrado.
replaceAllWith(replaceText)IntegerSubstitui todas as correspondências pelo texto especificado.
replaceWith(replaceText)IntegerSubstitui o texto de pesquisa na célula correspondente atual pelo texto especificado e retorna o número de ocorrências substituídas.
startFrom(startRange)TextFinderConfigura a pesquisa para começar imediatamente após o intervalo de células especificado.
useRegularExpression(useRegEx)TextFinderSe true, configura a pesquisa para interpretar a string de pesquisa como uma expressão regular. Caso contrário, a pesquisa interpreta a string de pesquisa como texto normal.

Documentação detalhada

findAll()

Retorna todas as células que correspondem aos critérios de pesquisa.

Retornar

Range[]: todas as células correspondentes.

Autorização

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

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

findNext()

Retorna a próxima célula que corresponde aos critérios de pesquisa.

Retornar

Range: a próxima célula correspondente ou null se não houver correspondências anteriores.

Autorização

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

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

findPrevious()

Retorna a célula anterior que corresponde aos critérios de pesquisa.

Retornar

Range: a célula correspondente anterior ou null se não houver correspondências anteriores.

Autorização

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

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

getCurrentMatch()

Retorna a célula atual que corresponde aos critérios de pesquisa.

Retornar

Range: a célula correspondente atual ou null se não houver mais correspondências.

Autorização

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

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

ignoreDiacritics(ignoreDiacritics)

Se true, a pesquisa será configurada para ignorar acentos ao fazer a correspondência. Caso contrário, a pesquisa vai corresponder a acentos. Um diacrítico é um sinal, como um acento ou uma cedilha, que, quando escrito acima ou abaixo de uma letra, indica uma diferença na pronúncia da mesma letra quando não marcada ou marcada de forma diferente.

Parâmetros

NomeTipoDescrição
ignoreDiacriticsBooleanSe a pesquisa considera acentos.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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

matchCase(matchCase)

Se true, configura a pesquisa para corresponder exatamente ao uso de maiúsculas e minúsculas do texto de pesquisa. Caso contrário, a pesquisa usa a correspondência sem diferenciação de maiúsculas e minúsculas por padrão.

Parâmetros

NomeTipoDescrição
matchCaseBooleanSe a correspondência diferencia maiúsculas de minúsculas.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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

matchEntireCell(matchEntireCell)

Se true, configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usa a correspondência parcial por padrão.

Parâmetros

NomeTipoDescrição
matchEntireCellBooleanSe toda a célula corresponde.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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

matchFormulaText(matchFormulaText)

Se true, configura a pesquisa para retornar correspondências que aparecem no texto da fórmula. Caso contrário, as células com fórmulas são consideradas com base no valor mostrado.

Parâmetros

NomeTipoDescrição
matchFormulaTextBooleanSe a pesquisa examina o texto da fórmula.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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

replaceAllWith(replaceText)

Substitui todas as correspondências pelo texto especificado. Retorna o número de ocorrências substituídas, que pode ser diferente do número de células correspondentes.

Parâmetros

NomeTipoDescrição
replaceTextStringO texto que substitui o texto nas células correspondentes.

Retornar

Integer: o número de ocorrências substituídas.

Autorização

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

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

replaceWith(replaceText)

Substitui o texto de pesquisa na célula correspondente atual pelo texto especificado e retorna o número de ocorrências substituídas.

Parâmetros

NomeTipoDescrição
replaceTextStringO texto que substitui o conteúdo na célula correspondente.

Retornar

Integer: o número de ocorrências substituídas.

Autorização

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

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

startFrom(startRange)

Configura a pesquisa para começar imediatamente após o intervalo de células especificado.

Parâmetros

NomeTipoDescrição
startRangeRangeO intervalo de células após o qual a pesquisa deve começar.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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

useRegularExpression(useRegEx)

Se true, configura a pesquisa para interpretar a string de pesquisa como uma expressão regular. Caso contrário, a pesquisa interpreta a string de pesquisa como texto normal. Para mais detalhes sobre como usar expressões regulares, consulte a página de suporte "Encontrar e substituir".

Parâmetros

NomeTipoDescrição
useRegExBooleanSe a string de pesquisa deve ser interpretada como uma expressão regular.

Retornar

TextFinder: este localizador de texto, para encadeamento.

Autorização

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

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