INavigateToItemProvider2 Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Language.NavigateTo.Interfaces
Assembly:
Microsoft.VisualStudio.Language.NavigateTo.Interfaces.dll

Extends INavigateToItemProvider with filtering functionality.

public interface class INavigateToItemProvider2 : IDisposable, Microsoft::VisualStudio::Language::NavigateTo::Interfaces::INavigateToItemProvider
public interface INavigateToItemProvider2 : IDisposable, Microsoft.VisualStudio.Language.NavigateTo.Interfaces.INavigateToItemProvider
type INavigateToItemProvider2 = interface
    interface INavigateToItemProvider
    interface IDisposable
Public Interface INavigateToItemProvider2
Implements IDisposable, INavigateToItemProvider
Implements
INavigateToItemProvider IDisposable

Properties

CanFilter

The provider has the ability to filter itself and will only return items matching the filtering parameters. The provider will be called with the StartSearch(INavigateToCallback, String, INavigateToFilterParameters) overload with the INavigateToFilterParameters parameter.
KindsProvided

Lists the kinds this provider will possibly return. This will be used to optimize the filtering by avoiding even calling the provider to search if it knows that nothing will be returned.

Methods

StartSearch(INavigateToCallback, String)

Indicates that the provider should begin a new search. If the provider is in the middle of a search, it should be terminated as soon as possible as the results of that search will now be ignored. Implementations of this method should move all work to a separate thread and allow this call to return as soon as possible.

(Inherited from INavigateToItemProvider)
StartSearch(INavigateToCallback, String, INavigateToFilterParameters)

Indicates that the provider should begin a new search. If the provider is in the middle of a search, it should be terminated as soon as possible as the results of that search will now be ignored. Implementations of this method should move all work to a separate thread and allow this call to return as soon as possible.
StopSearch()

Indicates that the provider should stop any current search.

(Inherited from INavigateToItemProvider)

Applies to