IVsWindowSearchHost Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Sets up a search control.

public interface class IVsWindowSearchHost

public interface class IVsWindowSearchHost

__interface IVsWindowSearchHost

[System.Runtime.InteropServices.Guid("576DEAF2-B527-4345-9A4B-BDAB6426FE03")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsWindowSearchHost

[<System.Runtime.InteropServices.Guid("576DEAF2-B527-4345-9A4B-BDAB6426FE03")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsWindowSearchHost = interface

Public Interface IVsWindowSearchHost

Attributes

GuidAttribute InterfaceTypeAttribute

Properties

HelpTopic	Gets or sets the help topic associated with the search control.
IsEnabled	Gets or sets whether the search control has been enabled or disabled.
IsPopupVisible	Gets or sets whether to show or hide the search control's popup (if the search control has settings requiring a popup, such as MRU, options, or filters).
IsVisible	Gets or sets whether to show or hide the search control.
SearchEvents	Gets the search events callback once the search has been set up with the host.
SearchObject	Gets the search object once the search has been set up with the host.
SearchQuery	Gets the current search query that resulted from the parsing the current text in the search control.
SearchQueryParser	Gets the search query parser used by the search host to create the search queries from search strings typed by the user.
SearchTask	Gets the current search task if a search is in progress.

Methods

Activate()	Sets focus to the search control.
SearchAsync(IVsSearchQuery)	Sets the search query and begins a search. If the query is null, the search is stopped if it had already started.
SetupSearch(IVsWindowSearch)	Associates the search host control with the window search provider.
TerminateSearch()	Disassociates the search host control from the window search provider, and releases resources used by the search.