EditPoint.FindPattern-Methode

Sucht ein angegebenes Vergleichsmuster im markierten Text.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
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

Parameter

  • Pattern
    Typ: String

    Erforderlich. Der zu suchende Text.

  • vsFindOptionsValue
    Typ: Int32

    Optional. Eine vsFindOptions-Konstante, die den Typ der auszuführenden Suche angibt. Der vsFindOptionsMatchInHiddenText-Konstantenwert wird nicht für diese Methode übernommen, da FindPattern sämtlichen Text, einschließlich ausgeblendetem Text, durchsucht.

  • EndPoint
    Typ: EnvDTE.EditPoint%

    Optional. Ein EditPoint-Objekt, das den Punkt darstellt, der an das Ende des gesuchten Musters verschoben werden soll.

  • Tags
    Typ: EnvDTE.TextRanges%

    Optional. Wenn das gesuchte Muster ein regulärer Ausdruck ist und markierte Unterausdrücke aufweist, enthält das Tags-Argument eine Auflistung von TextRange-Objekten, und zwar jeweils eines für jeden markierten Unterausdruck.

Rückgabewert

Typ: Boolean
true, wenn das Muster gefunden wurde; andernfalls false.

Hinweise

FindPattern durchsucht den gesamten (auch ausgeblendeten) Text vom Bearbeitungspunkt zum Ende des Dokuments nach dem vorgegebenen Textmuster. Ein Flag steuert, ob die Suche am Anfang des Dokuments beginnt. Das Muster kann ein regulärer oder sonstiger Ausdruck sein. Der Rückgabewert gibt an, ob das Muster gefunden wurde. Wenn das Muster gefunden wurde, wird der Bearbeitungspunkt an den Anfang der Übereinstimmung verschoben. Andernfalls wird die Bearbeitungsposition nicht geändert.

Wenn ein Endpunkt angegeben und das Muster gefunden wurde, verschiebt FindPattern den Endpunkt an das Ende des gefundenen Musters.

Wenn das gesuchte Muster ein regulärer Ausdruck ist und markierte Unterausdrücke enthält, gibt das Tags-Argument eine Auflistung von TextRange-Objekten zurück, und zwar jeweils eines für jeden markierten Unterausdruck.

Beispiele

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-Sicherheit

Siehe auch

Referenz

EditPoint Schnittstelle

EnvDTE-Namespace