Share via


FilterShortcutDefinition Class

Definition

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
FilterShortcutDefinition
Attributes

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