IVsWindowSearch Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.11.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Implemented by a window that wants to have searchable content. The search host will call this interface to initiate the search or obtain search options. When the interface is implemented by a tool window on the IVsWindowPane class or on VSFPROPID_ViewHelper, it will be called by shell on SearchEnabled to check if the search is enabled for the tool window. The shell will automatically set up a search host associated with the window, using the default placement for the search control in the shell frame/toolbar area.

public interface class IVsWindowSearch

public interface class IVsWindowSearch

__interface IVsWindowSearch

public interface IVsWindowSearch

[System.Runtime.InteropServices.Guid("8640A5BB-A6F8-4E4C-B4D7-C7041CFF3C71")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsWindowSearch

type IVsWindowSearch = interface

[<System.Runtime.InteropServices.Guid("8640A5BB-A6F8-4E4C-B4D7-C7041CFF3C71")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsWindowSearch = interface

Public Interface IVsWindowSearch

Derived: Microsoft.VisualStudio.Shell.ToolWindowPane

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

For an example, see Adding Search to a Tool Window.

Properties

Category	Gets the GUID of the search provider. For a tool window search provider, if the category is not returned the tool window guid will be used by default.
SearchEnabled	Determines whether the search should be enabled for the window.
SearchFiltersEnum	Returns an interface that can be used to enumerate search filters.
SearchOptionsEnum	Allows the window search host to obtain overridable search options.

Methods

ClearSearch()	Clears the search result, for example, after the user has cleared the content of the search edit box.
CreateSearch(UInt32, IVsSearchQuery, IVsSearchCallback)	Creates a new search task object. The task is cold-started - Start() needs to be called on the task object to begin the search.
OnNavigationKeyDown(UInt32, UInt32)	Allows the window to preview some keydown events that can be used to navigate between the search results or take action on them
ProvideSearchSettings(IVsUIDataSource)	Allows the window search host to obtain overridable search options.

Applies to