IVsWindowSearch Interface

 

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.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)

[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
[GuidAttribute("8640A5BB-A6F8-4E4C-B4D7-C7041CFF3C71")]
public interface IVsWindowSearch

NameDescription
System_CAPS_pubpropertyCategory

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.

System_CAPS_pubpropertySearchEnabled

Determines whether the search should be enabled for the window.

System_CAPS_pubpropertySearchFiltersEnum

Returns an interface that can be used to enumerate search filters.

System_CAPS_pubpropertySearchOptionsEnum

Allows the window search host to obtain overridable search options.

NameDescription
System_CAPS_pubmethodClearSearch()

Clears the search result, for example, after the user has cleared the content of the search edit box.

System_CAPS_pubmethodCreateSearch(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.

System_CAPS_pubmethodOnNavigationKeyDown(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

System_CAPS_pubmethodProvideSearchSettings(IVsUIDataSource)

Allows the window search host to obtain overridable search options.

Return to top
Show: