Esta página foi traduzida pela API Cloud Translation.

Class TextFinder

Encontre ou substitua texto em um intervalo, página ou planilha. Também pode especificar opções de pesquisa.

Métodos

Método	Tipo de retorno	Breve descrição
`findAll()`	`Range[]`	Retorna todas as células que correspondem aos critérios de pesquisa.
`findNext()`	`Range`	Retorna a próxima célula que corresponde aos critérios de pesquisa.
`findPrevious()`	`Range`	Retorna a célula anterior que corresponde aos critérios de pesquisa.
`getCurrentMatch()`	`Range`	Retorna a célula atual que corresponde aos critérios de pesquisa.
`ignoreDiacritics(ignoreDiacritics)`	`TextFinder`	Se `true`, configura a pesquisa para ignorar acentos durante a correspondência. Caso contrário, a pesquisa corresponde aos acentos.
`matchCase(matchCase)`	`TextFinder`	Se `true`, configura a pesquisa para corresponder exatamente ao caso do texto de pesquisa. Caso contrário, a pesquisa será padrão para correspondência sem distinção entre maiúsculas e minúsculas.
`matchEntireCell(matchEntireCell)`	`TextFinder`	Se `true`, configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa será parcial.
`matchFormulaText(matchFormulaText)`	`TextFinder`	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 exibido.
`replaceAllWith(replaceText)`	`Integer`	Substitui todas as correspondências pelo texto especificado.
`replaceWith(replaceText)`	`Integer`	Substitui o texto de pesquisa na célula correspondente com o texto especificado e retorna o número de ocorrências substituídas.
`startFrom(startRange)`	`TextFinder`	Configura a pesquisa para começar imediatamente após o intervalo de células especificado.
`useRegularExpression(useRegEx)`	`TextFinder`	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.

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 outras 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 acentos durante a correspondência. Caso contrário, a pesquisa corresponde aos acentos. Um diacrítico é um sinal, como um acento ou cedilla, 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

Nome	Tipo	Descrição
`ignoreDiacritics`	`Boolean`	Se 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 caso do texto de pesquisa. Caso contrário, a pesquisa será padrão para correspondência sem distinção entre maiúsculas e minúsculas.

Parâmetros

Nome	Tipo	Descrição
`matchCase`	`Boolean`	Se 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 será parcial.

Parâmetros

Nome	Tipo	Descrição
`matchEntireCell`	`Boolean`	Se a célula inteira é correspondente.

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 exibido.

Parâmetros

Nome	Tipo	Descrição
`matchFormulaText`	`Boolean`	Define se 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

Nome	Tipo	Descrição
`replaceText`	`String`	O 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 com o texto especificado e retorna o número de ocorrências substituídas.

Parâmetros

Nome	Tipo	Descrição
`replaceText`	`String`	O texto que substitui o conteúdo da 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

Nome	Tipo	Descrição
`startRange`	`Range`	O intervalo de células após o qual a pesquisa precisa 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 do recurso Encontrar e substituir.

Parâmetros

Nome	Tipo	Descrição
`useRegEx`	`Boolean`	Define se a string de pesquisa 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