EditPoint.FindPattern メソッド

選択したテキスト内で、指定した一致パターンを検索します。

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

構文

'宣言
Function FindPattern ( _
    Pattern As String, _
    vsFindOptionsValue As Integer, _
    <OutAttribute> ByRef EndPoint As EditPoint, _
    <OutAttribute> ByRef Tags As TextRanges _
) As Boolean
bool FindPattern(
    string Pattern,
    int vsFindOptionsValue,
    out EditPoint EndPoint,
    out TextRanges Tags
)
bool FindPattern(
    [InAttribute] String^ Pattern, 
    [InAttribute] int vsFindOptionsValue, 
    [InAttribute] [OutAttribute] EditPoint^% EndPoint, 
    [InAttribute] [OutAttribute] TextRanges^% Tags
)
abstract FindPattern : 
        Pattern:string * 
        vsFindOptionsValue:int * 
        EndPoint:EditPoint byref * 
        Tags:TextRanges byref -> bool 
function FindPattern(
    Pattern : String, 
    vsFindOptionsValue : int, 
    EndPoint : EditPoint, 
    Tags : TextRanges
) : boolean

パラメーター

  • vsFindOptionsValue
    型 : System.Int32
    省略可能。実行する検索の種類を示す vsFindOptions 定数。 FindPattern は隠し文字列を含めたすべての文字列を検索するため、vsFindOptionsMatchInHiddenText 定数値は、このメソッドには適用されません。
  • EndPoint
    型 : EnvDTE.EditPoint%
    省略可能。一致したパターンの末尾に移動するポイントを表す EditPoint オブジェクト。
  • Tags
    型 : EnvDTE.TextRanges%
    省略可能。一致するパターンがタグ付き部分式を含む正規表現の場合は、Tags 引数には、TextRange オブジェクト (各タグ付き部分式に 1 つ) のコレクションが含まれます。

戻り値

型 : System.Boolean
パターンが見つかった場合は true。それ以外の場合は false。

解説

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

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

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

Sub FindPatternExample()
   Dim objTextDoc As TextDocument
   Dim objEditPt As EditPoint, iCtr As Integer
        
   ' Create a new text file.
   DTE.ItemOperations.NewFile("General\Text File")
       
   ' Get a handle to the new document and create an EditPoint.
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")
   objEditPt = objTextDoc.StartPoint.CreateEditPoint
        
   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objeditpt.Insert("This is a test." & Chr(13))
   Next iCtr
   objEditPt.StartOfDocument()
   'Search for the word "test."
   If objeditpt.FindPattern("test") = True Then
      msgbox("Found the word.")
   End If
End Sub

.NET Framework セキュリティ

  • 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

EditPoint インターフェイス

EnvDTE 名前空間