此页面由 Cloud Translation API 翻译。

Class TextFinder

在范围、工作表或电子表格中查找或替换文本。还可以指定搜索选项。

方法

方法	返回类型	简介
`findAll()`	`Range[]`	返回与搜索条件匹配的所有单元格。
`findNext()`	`Range`	返回与搜索条件匹配的下一个单元格。
`findPrevious()`	`Range`	返回与搜索条件匹配的上一个单元格。
`getCurrentMatch()`	`Range`	返回与搜索条件匹配的当前单元格。
`ignoreDiacritics(ignoreDiacritics)`	`TextFinder`	如果为 `true`，则配置搜索在匹配时忽略变音符号；否则，搜索会匹配变音符号。
`matchCase(matchCase)`	`TextFinder`	如果为 `true`，则将搜索配置为与搜索文本的大小写完全匹配，否则搜索默认不区分大小写。
`matchEntireCell(matchEntireCell)`	`TextFinder`	如果为 `true`，则将搜索配置为匹配单元格的全部内容；否则，搜索将默认采用部分匹配。
`matchFormulaText(matchFormulaText)`	`TextFinder`	如果为 `true`，则配置搜索以返回公式文本中显示的匹配项；否则，系统会根据包含公式的单元格显示的值来进行考虑。
`replaceAllWith(replaceText)`	`Integer`	将所有匹配项替换为指定文本。
`replaceWith(replaceText)`	`Integer`	将当前匹配单元格中的搜索文本替换为指定文本，并返回替换的出现次数。
`startFrom(startRange)`	`TextFinder`	将搜索配置为在指定单元格范围之后立即开始搜索。
`useRegularExpression(useRegEx)`	`TextFinder`	如果为 `true`，则将搜索配置为将搜索字符串解释为正则表达式；否则，搜索会将搜索字符串解释为普通文本。

详细文档

`findAll()`

返回与搜索条件匹配的所有单元格。

Range[] - 所有匹配的单元格。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`findNext()`

返回与搜索条件匹配的下一个单元格。

Range - 下一个匹配单元格，如果没有之前的匹配项，则返回 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`findPrevious()`

返回与搜索条件匹配的上一个单元格。

Range - 上一个匹配单元格，如果没有上一个匹配项，则为 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getCurrentMatch()`

返回与搜索条件匹配的当前单元格。

Range - 当前匹配的单元格；如果没有其他匹配项，则返回 null。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`ignoreDiacritics(ignoreDiacritics)`

如果为 true，则配置搜索在匹配时忽略重音符号；否则，搜索会匹配重音符号。变音符号是一种符号，例如重音符号或塞耶尔符号，写在字母上方或下方，表示与未标记或标记方式不同的同一字母的发音不同。

参数

名称	类型	说明
`ignoreDiacritics`	`Boolean`	搜索是否考虑重音符号。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`matchCase(matchCase)`

如果为 true，则将搜索配置为与搜索文本的大小写完全匹配，否则搜索默认不区分大小写。

参数

名称	类型	说明
`matchCase`	`Boolean`	匹配时是否区分大小写。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`matchEntireCell(matchEntireCell)`

如果为 true，则将搜索配置为匹配单元格的全部内容；否则，搜索将默认采用部分匹配。

参数

名称	类型	说明
`matchEntireCell`	`Boolean`	是否匹配整个单元格。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`matchFormulaText(matchFormulaText)`

如果为 true，则配置搜索以返回公式文本中显示的匹配项；否则，系统会根据包含公式的单元格显示的值来进行考虑。

参数

名称	类型	说明
`matchFormulaText`	`Boolean`	搜索功能是否会检查公式文本。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`replaceAllWith(replaceText)`

将所有匹配项替换为指定文本。返回替换的出现次数，该数值可能与匹配单元格的数量不同。

参数

名称	类型	说明
`replaceText`	`String`	用于替换匹配单元格中的文本的文本。

Integer - 替换的出现次数。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`replaceWith(replaceText)`

将当前匹配单元格中的搜索文本替换为指定文本，并返回替换的出现次数。

参数

名称	类型	说明
`replaceText`	`String`	用于替换当前匹配单元格中内容的文本。

Integer - 替换的出现次数。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`startFrom(startRange)`

将搜索配置为在指定单元格范围之后立即开始搜索。

参数

名称	类型	说明
`startRange`	`Range`	应从中开始搜索的单元格范围。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`useRegularExpression(useRegEx)`

如果为 true，则将搜索配置为将搜索字符串解释为正则表达式；否则，搜索会将搜索字符串解释为普通文本。如需详细了解如何使用正则表达式，请参阅 “查找和替换”支持页面。

参数

名称	类型	说明
`useRegEx`	`Boolean`	是否将搜索字符串解释为正则表达式。

TextFinder - 此文本查找器，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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