Esta página foi traduzida pela API Cloud Translation.

Class TextFinder

(em inglês)

Localize ou substitua texto em um intervalo, uma planilha ou uma 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 sinais diacríticos durante a correspondência. Caso contrário, a pesquisa corresponderá a diacríticos.
`matchCase(matchCase)`	`TextFinder`	Se `true`, configura a pesquisa para corresponder exatamente ao caso de texto da pesquisa. Caso contrário, a pesquisa usará como padrão a correspondência indiferente a maiúsculas.
`matchEntireCell(matchEntireCell)`	`TextFinder`	Se `true`, a pesquisa será configurada para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usará a correspondência parcial por padrão.
`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 serã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 atualmente pelo texto especificado e retorna o número de ocorrências substituídas.
`startFrom(startRange)`	`TextFinder`	Configura a pesquisa para iniciar a pesquisa 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 interpretará 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, configura a pesquisa para ignorar sinais diacríticos durante a correspondência. Caso contrário, a pesquisa corresponderá a diacríticos. Um diacrítico é um sinal, como um sotaque ou cedilha, que, quando gravado acima ou abaixo de uma letra, indica uma diferença na pronúncia da mesma letra quando desmarcado ou marcado de maneira diferente.

Parâmetros

Nome	Tipo	Descrição
`ignoreDiacritics`	`Boolean`	Se a pesquisa considera diacríticos.

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 de texto da pesquisa. Caso contrário, a pesquisa usará como padrão a correspondência indiferente a maiú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, a pesquisa será configurada para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usará a correspondência parcial por padrão.

Parâmetros

Nome	Tipo	Descrição
`matchEntireCell`	`Boolean`	Indica se há correspondência com toda a célula.

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 serão consideradas com base no valor exibido.

Parâmetros

Nome	Tipo	Descrição
`matchFormulaText`	`Boolean`	Indica 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 atualmente pelo 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 na célula correspondente no momento.

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

Parâmetros

Nome	Tipo	Descrição
`startRange`	`Range`	O intervalo de células em que a pesquisa será iniciada.

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 interpretará a string de pesquisa como texto normal. Para mais detalhes sobre como usar expressões regulares, consulte Encontrar e substituir páginas de suporte.

Parâmetros

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