Class TextFinder

TextFinder

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

Methods

メソッド戻り値の型概要
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