TextSelection.FindPattern メソッド

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

更新 : 2007 年 11 月

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

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

構文

'宣言
Function FindPattern ( _
    Pattern As String, _
    vsFindOptionsValue As Integer, _
    <OutAttribute> ByRef Tags As TextRanges _
) As Boolean
'使用
Dim instance As TextSelection
Dim Pattern As String
Dim vsFindOptionsValue As Integer
Dim Tags As TextRanges
Dim returnValue As Boolean

returnValue = instance.FindPattern(Pattern, _
    vsFindOptionsValue, Tags)

bool FindPattern(
    string Pattern,
    int vsFindOptionsValue,
    out TextRanges Tags
)

bool FindPattern(
    [InAttribute] String^ Pattern, 
    [InAttribute] int vsFindOptionsValue, 
    [InAttribute] [OutAttribute] TextRanges^% Tags
)

function FindPattern(
    Pattern : String, 
    vsFindOptionsValue : int, 
    Tags : TextRanges
) : boolean

パラメータ

Pattern
型 : System.String

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

vsFindOptionsValue
型 : System.Int32

vsFindOptions 値のいずれか。

Tags
型 : EnvDTE.TextRanges%

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

戻り値

型 : System.Boolean

パターンが見つかった場合は true を示し、それ以外の場合は false を示すブール値。

解説

FindPattern は、エディットポイントからドキュメントの末尾まで、指定したテキストパターンを検索します。ドキュメントの先頭から検索を開始するかどうかを制御するには、フラグを使用します。パターンには、正規表現またはその他の表現を使用できます。戻り値は、パターンが見つかったかどうかを示します。パターンが見つかった場合は、エディットポイントが一致の先頭に移動します。それ以外の場合は、編集位置は変更されません。

終点を指定している場合にパターンが見つかると、FindPattern は、見つかったパターンの末尾に終点を移動します。

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

例

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

   ' Advance to the next Visual Basic function beginning or end by 
   ' searching for  "Sub" with white space before and after it.
   If objSel.FindPattern(":WhSub:Wh", vsFindOptions.vsFindOptionsRegularExpression) Then
      ' Select the entire line.
      objSel.SelectLine()
   End If
End Sub