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