Class TextFinder

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，则配置搜索以在匹配时忽略变音符号；否则，搜索会匹配变音符号。变音符号是一种符号，例如重音符号或软音符，写在字母上方或下方时，表示发音与未标记或标记不同的同一字母的发音不同。

参数

名称类型说明
ignoreDiacriticsBoolean搜索是否考虑变音符号。

返回

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

授权

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

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

matchCase(matchCase)

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

参数

名称类型说明
matchCaseBoolean匹配是否区分大小写。

返回

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

授权

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

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

matchEntireCell(matchEntireCell)

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

参数

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

返回

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

授权

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

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

matchFormulaText(matchFormulaText)

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

参数

名称类型说明
matchFormulaTextBoolean搜索是否检查公式文本。

返回

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

授权

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

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

replaceAllWith(replaceText)

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

参数

名称类型说明
replaceTextString替换匹配单元格中的文本的文本。

返回

Integer - 替换的出现次数。

授权

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

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

replaceWith(replaceText)

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

参数

名称类型说明
replaceTextString替换当前匹配的单元格中的内容的文本。

返回

Integer - 替换的出现次数。

授权

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

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

startFrom(startRange)

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

参数

名称类型说明
startRangeRange搜索应在哪个单元格范围之后开始。

返回

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

授权

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

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

useRegularExpression(useRegEx)

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

参数

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

返回

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

授权

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

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