Skip to main content

FilterBehavior Members

Allows you to use the Filter Editor, Filter Panel, and Filter Elements to filter data-bound controls that do not have integrated filter elements (for example, Chart, Scheduler, Data Editors).

Constructors

Name Description
FilterBehavior() Initializes a new instance of the FilterBehavior class.

Fields

Name Description
ActualFilterCriteriaProperty static Identifies the FilterBehavior.ActualFilterCriteria dependency property.
FieldsProperty static Identifies the FilterBehavior.Fields dependency property.
FilterCriteriaProperty static Identifies the FilterBehavior.FilterCriteria dependency property.
FilterDisplayTextProperty static Identifies the FilterBehavior.FilterDisplayText dependency property.
FilterEditorDialogServiceTemplateProperty static Identifies the FilterBehavior.FilterEditorDialogServiceTemplate dependency property.
FilterEditorTemplateProperty static Identifies the FilterBehavior.FilterEditorTemplate dependency property.
FilterStringProperty static Identifies the FilterBehavior.FilterString dependency property.
IsFilterEnabledProperty static Identifies the IsFilterEnabled dependency property.
ItemsSourceProperty static Identifies the FilterBehavior.ItemsSource dependency property.
MRUFilterListCountProperty static Identifies the FilterBehavior.MRUFilterListCount dependency property.
ShowAllFilterValuesProperty static Identifies the FilterBehavior.ShowAllFilterValues dependency property.

Properties

Name Description
ActualFilterCriteria Gets the filter criteria created by the FilterBehavior. You can assign this filter criteria to a data-bound control’s filter criteria or use it to filter your data in code.
Fields Gets a collection of fields. Specify the Fields property to configure display fields, edit settings, and predefined filters.
FilterCriteria Gets or sets the filter expression applied to the FilterBehavior.
FilterDisplayText Gets a display text of the filter expression applied to the FilterBehavior.
FilterEditorDialogServiceTemplate Gets or sets a template that defines the presentation of the window that hosts the Filter Editor. This is a dependency property.
FilterEditorTemplate Gets or sets a template that defines the presentation of the Filter Editor. This is a dependency property.
FilteringContext Gets an object the FilterBehavior uses to interact with a data-bound control.
FilterString Gets or sets a string that is the filter expression applied to the FilterBehavior.
HasAnimatedProperties Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object’s dependency properties. Inherited from Animatable.
IsFilterEnabled Gets or sets whether the current filter is enabled.
ItemsSource Gets or sets a source from which the Filter Editor / Filter Elements get unique filter values.
MRUFilterListCount Gets or sets the maximum number of the most recently used (MRU) filter conditions.
ShowAllFilterValues Gets or sets whether to allow users to select All filter values.
ShowFilterEditorCommand Invokes the Filter Editor.

Methods

Name Description
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
ApplyAnimationClock(DependencyProperty, AnimationClock) Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. Inherited from Animatable.
BeginAnimation(DependencyProperty, AnimationTimeline) Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. Inherited from Animatable.
Clone() Creates a modifiable clone of this Animatable, making deep copies of this object’s values. When copying this object’s dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. Inherited from Animatable.
GetAnimationBaseValue(DependencyProperty) Returns the non-animated value of the specified DependencyProperty. Inherited from Animatable.
ShouldSerializeStoredWeakReference(DependencyObject) static Specifies whether a dependency object should be serialized. Inherited from Animatable.
ShowFilterEditor(String) Invokes the Filter Editor.

Events

Name Description
ActualFilterCriteriaChanged Occurs when the filter criteria is changed.
CustomUniqueValues Allows you to specify unique values displayed within a filter element.
CustomValueDisplayText Allows you to customize the display text for a filter value.
See Also