Class TextFinder

テキスト検索

範囲、シート、スプレッドシート内のテキストを検索または置換します。検索オプションを指定することもできます。

メソッド

メソッド戻り値の型概要
findAll()Range[]検索条件に一致するすべてのセルを返します。
findNext()Range検索条件に一致する次のセルを返します。
findPrevious()Range検索条件に一致する前のセルを返します。
getCurrentMatch()Range検索条件に一致する現在のセルを返します。
ignoreDiacritics(ignoreDiacritics)TextFindertrue の場合、照合中にアクセント記号を無視するように検索を構成します。それ以外の場合、検索はアクセント記号と一致します。
matchCase(matchCase)TextFindertrue の場合、検索テキストの大文字と小文字を完全に一致させるように検索を構成します。それ以外の場合は、検索はデフォルトで大文字と小文字を区別しない照合になります。
matchEntireCell(matchEntireCell)TextFindertrue の場合、セルの内容全体と一致するように検索を構成します。それ以外の場合は、検索はデフォルトで部分一致になります。
matchFormulaText(matchFormulaText)TextFindertrue の場合、数式のテキスト内に表示される一致を返すように検索を構成します。それ以外の場合は、数式を含むセルは表示される値に基づいて考慮されます。
replaceAllWith(replaceText)Integer一致したすべてのテキストを指定されたテキストに置き換えます。
replaceWith(replaceText)Integer現在一致しているセル内の検索テキストを指定されたテキストに置き換え、置換された回数を返します。
startFrom(startRange)TextFinder指定したセル範囲の直後に検索を開始するように検索を構成します。
useRegularExpression(useRegEx)TextFindertrue の場合、検索文字列を正規表現として解釈するように検索を構成します。それ以外の場合は、検索文字列を通常のテキストとして解釈します。

詳細なドキュメント

findAll()

検索条件に一致するすべてのセルを返します。

戻る

Range[] - 一致するすべてのセル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

findNext()

検索条件に一致する次のセルを返します。

戻る

Range - 次に一致するセル。一致するセルが前方にも後方にもない場合は null です。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

findPrevious()

検索条件に一致する前のセルを返します。

戻る

Range - 前回の一致するセル。前回の一致がない場合、null です。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

getCurrentMatch()

検索条件に一致する現在のセルを返します。

戻る

Range - 現在の一致するセル。一致が他にない場合は null。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

ignoreDiacritics(ignoreDiacritics)

true の場合、照合中にアクセント記号を無視するように検索を構成します。それ以外の場合、検索はアクセント記号と一致します。アクセント記号は、アクセント記号やセディラなどの記号で、文字の上にまたは下に書かれると、同じ文字にアクセント記号が付いていないときや、別のアクセント記号が付いているときとは発音が異なることを示します。

パラメータ

名前型説明
ignoreDiacriticsBoolean検索でアクセント記号を考慮するかどうか。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

matchCase(matchCase)

true の場合、検索テキストの大文字と小文字を完全に一致させるように検索を構成します。それ以外の場合は、検索はデフォルトで大文字と小文字を区別しない照合になります。

パラメータ

名前型説明
matchCaseBoolean大文字と小文字が区別されるかどうか。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

matchEntireCell(matchEntireCell)

true の場合、セルの内容全体と一致するように検索を構成します。それ以外の場合は、検索はデフォルトで部分一致になります。

パラメータ

名前型説明
matchEntireCellBooleanセル全体が一致するかどうか。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

matchFormulaText(matchFormulaText)

true の場合、数式のテキスト内に表示される一致を返すように検索を構成します。それ以外の場合は、数式を含むセルは表示される値に基づいて考慮されます。

パラメータ

名前型説明
matchFormulaTextBoolean検索で数式のテキストを調べるかどうか。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

replaceAllWith(replaceText)

一致したすべてのテキストを指定されたテキストに置き換えます。置換された回数を返します。一致したセルの数とは異なる場合があります。

パラメータ

名前型説明
replaceTextString一致したセルのテキストに置き換えるテキスト。

戻る

Integer - 置換された回数。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

replaceWith(replaceText)

現在一致しているセル内の検索テキストを指定されたテキストに置き換え、置換された回数を返します。

パラメータ

名前型説明
replaceTextString現在一致しているセルのコンテンツに置き換えるテキスト。

戻る

Integer - 置換された回数。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

startFrom(startRange)

指定したセル範囲の直後に検索を開始するように検索を構成します。

パラメータ

名前型説明
startRangeRange検索を開始するセル範囲。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

useRegularExpression(useRegEx)

true の場合、検索文字列を正規表現として解釈するように検索を構成します。それ以外の場合は、検索文字列を通常のテキストとして解釈します。正規表現の使用方法について詳しくは、 検索と置換のサポートページをご覧ください。

パラメータ

名前型説明
useRegExBoolean検索文字列を正規表現として解釈するかどうか。

戻る

TextFinder - チェーン用のテキスト検索ツール。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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