TextSelection.FindText メソッド

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

アクティブポイントからドキュメントの末尾まで指定のテキストを検索します。

名前空間 : EnvDTE
アセンブリ : EnvDTE (EnvDTE.dll 内)

構文

'宣言
Function FindText ( _
    Pattern As String, _
    vsFindOptionsValue As Integer _
) As Boolean
'使用
Dim instance As TextSelection
Dim Pattern As String
Dim vsFindOptionsValue As Integer
Dim returnValue As Boolean

returnValue = instance.FindText(Pattern, _
    vsFindOptionsValue)

bool FindText(
    string Pattern,
    int vsFindOptionsValue
)

bool FindText(
    [InAttribute] String^ Pattern, 
    [InAttribute] int vsFindOptionsValue
)

function FindText(
    Pattern : String, 
    vsFindOptionsValue : int
) : boolean

パラメータ

Pattern
型 : System.String

必ず指定します。検索する文字列。

vsFindOptionsValue
型 : System.Int32

省略可能です。使用する検索オプションを示す vsFindOptions 定数。

戻り値

型 : System.Boolean

テキストが見つかった場合は true を示し、それ以外の場合は false を示すブール値。

解説

FindText は、選択したテキストのアクティブな終点からテキストドキュメントの末尾まで指定の文字列を検索します。戻り値は、テキストが見つかったかどうかを示します。テキストが見つかった場合は、エディットポイントが一致した項目の先頭に移動します。それ以外の場合は、編集位置は変更されません。

一致するパターンがタグ付き部分式を含む正規表現の場合、Tags 引数は、TextRange オブジェクト (各タグ付き部分式に 1 つ) のコレクションを返します。

例

Sub FindTextExample()
   ' Before running this example, open a text document.
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection

   ' Looks for the first occurence of the word, test, in the current 
   ' document. If found, the line is selected.
   If objSel.FindText("test", vsFindOptions.vsFindOptionsFromStart) Then
      objSel.SelectLine()
   End If
End Sub