IncrementalSearch.Pattern Property

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets the characters being processed in the current ISearch.

public:
 property System::String ^ default { System::String ^ get(); };

public:
 property Platform::String ^ default { Platform::String ^ get(); };

[System.Runtime.InteropServices.DispId(0)]
public string this { [System.Runtime.InteropServices.DispId(0)] get; }

[<System.Runtime.InteropServices.DispId(0)>]
[<get: System.Runtime.InteropServices.DispId(0)>]
member this.Pattern : string

Default Public ReadOnly Property Pattern As String

Property Value

String

The characters being processed in the current ISearch.

Attributes

DispIdAttribute

Examples

Sub testIS2()  
    ' Before running, open a document in Visual Studio.  
    ' Set variables for text pane.  
    Dim tp As EnvDTE80.TextPane2  
    tp = CType(DTE.ActiveDocument.ActiveWindow.Object.ActivePane, _  
    TextPane2)  
    ' Start an incremental search backward from  
    ' the current insertion point in the document.  
    tp.IncrementalSearch.StartBackward()  
    ' Add the character "a" to the search pattern.  
    tp.IncrementalSearch.AppendCharAndSearch(Asc("a"))  
    ' Display the parent name for IncrementalSearch object.  
    MsgBox("IncrementalSearch parent: " & _  
    tp.IncrementalSearch.DTE.FullName)  
    MsgBox("Search pattern length: " & _  
    tp.IncrementalSearch.Pattern.Length)  
    ' Perform incremental search using the pattern ("a").  
    tp.IncrementalSearch.SearchWithLastPattern()  
    ' After the search, exit incremental search mode.  
    MsgBox("DeleteCharAndBackup")  
    tp.IncrementalSearch.DeleteCharAndBackup()  
    MsgBox("SearchForward")  
    tp.IncrementalSearch.SearchForward()  
    MsgBox("SearchBackward")  
    tp.IncrementalSearch.SearchBackward()  
    MsgBox("Exit")  
    tp.IncrementalSearch.Exit()  
End Sub  

Remarks

This string is updated with each call to AppendCharAndSearch or DeleteCharAndBackup and represents the most current ISearch pattern.