FilterShortcutDefinition Class

Reference

Definition

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

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

Package:: Microsoft.VisualStudio.Language.NavigateTo.Interfaces v17.12.215

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.

Important

This API is not CLS-compliant.

Defines a custom filter shortcut which will toggle the associated filters.

public ref class FilterShortcutDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
public ref class FilterShortcutDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
class FilterShortcutDefinition abstract

[System.CLSCompliant(false)]
public abstract class FilterShortcutDefinition

public abstract class FilterShortcutDefinition

[<System.CLSCompliant(false)>]
type FilterShortcutDefinition = class

type FilterShortcutDefinition = class

Public MustInherit Class FilterShortcutDefinition

Inheritance: Object
FilterShortcutDefinition

Attributes: CLSCompliantAttribute

Remarks

This is a MEF component part, and should be exported as: [Export(typeof(FilterShortcutDefinition))]

Exporters must provide the NameAttribute. The OrderAttribute may be provided optionally.

Constructors

FilterShortcutDefinition()

Properties

ActivationSequence	The character sequence for the search box used to invoke the filter shortcut.
Button	UI button for the filter shortcut.
DefaultOptions	Default values for NavigateToOptions for this filter.
Description	The description presented in the filter shortcut help result list.
IsDelimiterRequired	Is a delimiter between the activation sequence string and the search string required?
IsExclusive	This filter shortcut will not invoke a search on any INavigateToItemProvider except those that say they can possibly return values allowed by the filters associated with this filter shortcut. Also, only filters associated with this shortcut will appear in the UI.
ShouldSearchImmediately	A search is requested from provider immediately when the filter shortcut is activated even when no search parameter is provided.

Applies to

Share via