Find(String,Int32,Int32,RichTextBoxFinds) メソッド

特定の検索オプションを適用し、コントロール内の指定したテキスト範囲内で文字列を検索します。

構文

Visual Basic (宣言)
C#

Public Overloads Function Find( _
   ByVal str As String, _
   ByVal start As Integer, _
   ByVal end As Integer, _
   ByVal options As RichTextBoxFinds _
) As Integer

public int Find( 
   string str,
   int start,
   int end,
   RichTextBoxFinds options
)

パラメータ

str: コントロール内で検索する文字列を表すString値。
start: コントロールのテキスト内で検索を開始する位置を表すInt32値。
end: コントロールのテキスト内で検索を終了する位置を表すInt32値。この値は -1 またはstartパラメータの値以上であることが必要です。
options: 検索オプションを表すRichTextBoxFinds 値のビットごとの組み合わせ。

戻り値の型

検索文字列が見つかったコントロール内の位置を表すInt32値。検索文字列が見つからない場合、またはパラメータで空の検索文字列が指定された場合は -1。

解説

このFind メソッドは、strパラメーターで指定されたテキストを検索し、コントロール内で最初に見つかった検索文字列の位置を返します。プロパティが負の値を返す場合は、検索対象の文字列がコントロールの内容の中に見つからなかったことを示します。このメソッドを使用して検索機能を作成し、その機能をコントロールのユーザーに提供できます。また、このメソッドは、特定の書式に置換するテキストを検索する場合にも役立ちます。たとえば、ユーザーがコントロールに日付を入力した場合、Find メソッドを使用してドキュメント内のすべての日付を検索し、見つかった日付を適切な書式に置換した後で、コントロールのSaveFile(String) メソッドを使用できます。

このバージョンのFind メソッドには、検索条件の拡張または絞り込みができるオプションがあります。検索語の大文字と小文字を区別するオプションや、語の一部ではなく全体を検索するオプションを指定できます。optionsパラメーターでRichTextBoxFinds.Reverse列挙体を指定すると、既定の方向（ドキュメントの先頭から末尾へ）とは逆の方向（ドキュメントの末尾から先頭へ）でテキストを検索できます。このバージョンのFind メソッドでは、コントロールのテキスト内での検索開始位置と終了位置を指定して、テキストの検索範囲を絞り込むこともできます。この機能により、検索範囲をコントロール内のテキストの特定部分に限定できます。endパラメーターの値に-1を指定すると、通常方向の検索では、GcRichTextBox内のテキストの末尾まで検索されます。逆方向の検索では、テキストの末尾からstartパラメーターで定義された位置までが検索されます。startパラメーターとendパラメーターに同じ値を指定すると、通常方向ではコントロール全体が検索されます。逆方向でもコントロール全体が検索されますが、検索方向がドキュメントの末尾から先頭方向になります。

参照

GcRichTextBox クラス
 GcRichTextBox メンバ
 オーバーロード一覧