Class TextFinder

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