Share via

IVsSearchProvider 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
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Exposes a single search provider.

public interface class IVsSearchProvider
public interface class IVsSearchProvider
__interface IVsSearchProvider
public interface IVsSearchProvider
[System.Runtime.InteropServices.Guid("E85FDFC2-A874-4871-88A3-A2E904183A05")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsSearchProvider
type IVsSearchProvider = interface
[<System.Runtime.InteropServices.Guid("E85FDFC2-A874-4871-88A3-A2E904183A05")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsSearchProvider = interface
Public Interface IVsSearchProvider
Derived
Attributes
GuidAttribute InterfaceTypeAttribute

Properties

Category

Gets an identifier for the search provider.
Description

Gets a description of the provider results, for example "Searches top-level menu items."
DisplayText

Gets a displayable name for the search provider, for example "Menu items."
Shortcut

Gets a unique category shortcut that can be used in filtering the results from multiple providers. For example, searching for "@cmd" only returns search results from the provider with category shortcut "cmd".
Tooltip

Gets a tooltip for the provider. The tooltip is displayed when it appears in the Global Search UI instead of "Show results from this category only".

Methods

CreateItemResult(String)

Creates a new instance of a search result from a persistence string previously obtained by getting the value of the persistence data string.
CreateSearch(UInt32, IVsSearchQuery, IVsSearchProviderCallback)

Creates a search task from the specified cookie and search query.
ProvideSearchSettings(IVsUIDataSource)

Injects specialized settings into the data model associated with the command search provider.

Applies to