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

特定の検索オプションを適用し、コントロール内のテキストで、特定の位置にある文字列を検索します。

構文

Visual Basic (宣言)
C#

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

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

パラメータ

str: コントロール内で検索する文字列を表すString値。
start: コントロールのテキスト内で検索を開始する位置を表すInt32値。
options: 検索オプションを表すRichTextBoxFinds値のビットごとの組み合わせ。

戻り値の型

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

解説

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

このバージョンのFind メソッドには、検索条件の拡張または絞り込みができるオプションがあります。検索語の大文字と小文字を区別するオプションや、語の一部ではなく全体を検索するオプションを指定できます。optionsパラメーターでRichTextBoxFinds.Reverse列挙体を指定すると、既定の方向（ドキュメントの先頭から末尾へ）とは逆の方向（ドキュメントの末尾から先頭へ）でテキストを検索できます。このバージョンのFind メソッドでは、コントロールのテキスト内での検索開始位置を指定して、テキストの検索範囲を絞り込むこともできます。この機能により、すでに検索した可能性のあるテキストや、検索文字列が含まれていないと判明している場所を検索範囲から除外できます。optionsパラメーターにRichTextBoxFinds.Reverse値を指定すると、ドキュメントの末尾から検索が開始されます。そのため、startパラメーターはこの逆方向の検索が終了する位置を示します。stringをパラメーターとして受け取るFind メソッドでは、GcRichTextBox内の複数行に含まれるテキストは検索できません。このような検索を実行すると、値-1が返されます。

参照

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