IncrementalSearch.Pattern Property

Gets the characters being processed in the current ISearch.

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

Syntax

'Declaration
ReadOnly Default Property Pattern As String
string this { get; }
property String^ default {
    String^ get ();
}
abstract Pattern : string with get
function get Pattern () : String

Property Value

Type: System.String
The characters being processed in the current ISearch.

Remarks

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

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

.NET Framework Security

See Also

Reference

IncrementalSearch Interface

EnvDTE80 Namespace

Other Resources

How to: Search for Text Incrementally

How to: Search a Document Incrementally