IncrementalSearch Interface

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides access to the incremental search (ISearch) capability of the text editor.

public interface class IncrementalSearch

public interface class IncrementalSearch

__interface IncrementalSearch

[System.Runtime.InteropServices.Guid("C5BEE6D8-ED45-4317-96BF-97EB88EA3A07")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface IncrementalSearch

[System.Runtime.InteropServices.Guid("C5BEE6D8-ED45-4317-96BF-97EB88EA3A07")]
public interface IncrementalSearch

[<System.Runtime.InteropServices.Guid("C5BEE6D8-ED45-4317-96BF-97EB88EA3A07")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type IncrementalSearch = interface

[<System.Runtime.InteropServices.Guid("C5BEE6D8-ED45-4317-96BF-97EB88EA3A07")>]
type IncrementalSearch = interface

Public Interface IncrementalSearch

Attributes: GuidAttribute TypeLibTypeAttribute

Examples

Sub testIS()  
    ' Set variables for text pane.  
    Dim tp As EnvDTE80.TextPane2  
    tp = CType(DTE.ActiveDocument.ActiveWindow.Object.ActivePane, _  
    TextPane2)  
    ' Start an incremental search forward from  
    ' the current insertion point in the document.  
    tp.IncrementalSearch.StartForward()  
    ' Add the character "a" to the search pattern.  
    tp.IncrementalSearch.AppendCharAndSearch(Asc("a"))  
    ' Perform incremental search using the pattern ("a").  
    tp.IncrementalSearch.SearchWithLastPattern()  
    ' After the search, exit incremental search mode.  
    tp.IncrementalSearch.Exit()  
End Sub

Properties

DTE	Gets the top-level extensibility object.
IncrementalSearchModeOn	Gets a value indicating whether an ISearch is being performed.
Pattern	Gets the characters being processed in the current ISearch.

Methods

AppendCharAndSearch(Int16)	Adds a character to the ISearch pattern and performs a search for the new string.
DeleteCharAndBackup()	Removes one character from the search pattern and moves the selection back to the previous match.
Exit()	Stops the current ISearch and returns the editor to its basic behavior.
SearchBackward()	Searches for the current pattern from the current position to the beginning of the document.
SearchForward()	Searches for the current pattern from the current position to the end of the document.
SearchWithLastPattern()	Repeats the current ISearch without changing the pattern
StartBackward()	Starts a backward search.
StartForward()	Starts a forward search.

Applies to

Share via