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, configura a pesquisa para ignorar diacríticos durante a correspondência. Caso contrário, a pesquisa corresponde a diacríticos.
matchCase(matchCase)TextFinderSe for true, configura a pesquisa para corresponder exatamente ao texto da pesquisa. Caso contrário, a pesquisa será padronizada com correspondência indiferente a maiúsculas.
matchEntireCell(matchEntireCell)TextFinderSe true, configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa é padronizada com correspondência parcial.
matchFormulaText(matchFormulaText)TextFinderSe for 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 exibido.
replaceAllWith(replaceText)IntegerSubstitui todas as correspondências pelo texto especificado.
replaceWith(replaceText)IntegerSubstitui o texto da pesquisa na célula correspondente no momento pelo texto especificado e retorna o número de ocorrências substituídas.
startFrom(startRange)TextFinderConfigura a pesquisa para iniciar 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 interpretará a string de pesquisa como texto normal.

Documentação detalhada

findAll()

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

Retorno

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.

Retorno

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.

Retorno

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.

Retorno

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, configura a pesquisa para ignorar diacríticos durante a correspondência. Caso contrário, a pesquisa corresponde a diacríticos. Um diacrítico é um sinal, como um sotaque ou 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 maneira diferente.

Parâmetros

NomeTipoDescrição
ignoreDiacriticsBooleanSe a pesquisa considera diacríticos.

Retorno

TextFinder: 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 for true, configura a pesquisa para corresponder exatamente ao texto da pesquisa. Caso contrário, a pesquisa será padronizada com correspondência indiferente a maiúsculas.

Parâmetros

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

Retorno

TextFinder: 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 é padronizada com correspondência parcial.

Parâmetros

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

Retorno

TextFinder: 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 for 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 exibido.

Parâmetros

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

Retorno

TextFinder: 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.

Retorno

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 da pesquisa na célula correspondente no momento 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.

Retorno

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 iniciar imediatamente após o intervalo de células especificado.

Parâmetros

NomeTipoDescrição
startRangeRangeO intervalo de células depois do qual a pesquisa deve começar.

Retorno

TextFinder: 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 interpretará a string de pesquisa como texto normal. Para saber mais sobre como usar expressões regulares, consulte a página de suporte "Localizar e substituir".

Parâmetros

NomeTipoDescrição
useRegExBooleanDefine se a string de pesquisa deve ser interpretada como expressão regular.

Retorno

TextFinder: 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