FilterBehavior Members

Allows you to use the Filter Editor, Filter Panel, and Filter Elements to filter data-bound controls that do not provide a filtering UI (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
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.
CanFreeze Gets a value that indicates whether the object can be made unmodifiable. Inherited from Freezable.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
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.
IsFrozen Gets a value that indicates whether the object is currently modifiable. Inherited from Freezable.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
ItemsSource Gets or sets a source from which the Filter Editor / Filter Elements get unique filter values.
MRUFilterListCount
ShowAllFilterValues Gets or sets whether to allow users to select All filter values.
ShowFilterEditorCommand Invokes the Filter Editor.

Methods

Name Description
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.
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.
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.
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.
CheckAccess() Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
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.
CloneCore(Freezable) protected Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
CloneCurrentValue() Creates a modifiable clone (deep copy) of the Freezable using its current values. Inherited from Freezable.
CloneCurrentValueCore(Freezable) protected Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. Inherited from Freezable.
CoerceValue(DependencyProperty) Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateInstance() protected Initializes a new instance of the Freezable class. Inherited from Freezable.
Equals(Object) Determines whether a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Freeze() Makes the current object unmodifiable and sets its IsFrozen property to true. Inherited from Freezable.
Freeze(Freezable, Boolean) protected static If the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded. Inherited from Freezable.
GetAnimationBaseValue(DependencyProperty) Returns the non-animated value of the specified DependencyProperty. Inherited from Animatable.
GetAsFrozen() Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetAsFrozenCore(Freezable) protected Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
GetCurrentValueAsFrozen() Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetCurrentValueAsFrozenCore(Freezable) protected Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. Inherited from Freezable.
GetHashCode() Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator() Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty) Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InvalidateProperty(DependencyProperty) Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnChanged() protected Called when the current Freezable object is modified. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject) protected Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) protected This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Inherited from Freezable.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protected Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. Inherited from Freezable.
ReadLocalValue(DependencyProperty) Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReadPreamble() protected Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. Inherited from Freezable.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetCurrentValue(DependencyProperty, Object) Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protected Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ShouldSerializeStoredWeakReference(DependencyObject) static Specifies whether a dependency object should be serialized. Inherited from Animatable.
ShowFilterEditor(String) Invokes the Filter Editor.
ToString() Returns a string that represents the current object. Inherited from Object.
VerifyAccess() Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
WritePostscript() protected Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. Inherited from Freezable.
WritePreamble() protected Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. Inherited from Freezable.

Events

Name Description
ActualFilterCriteriaChanged Occurs when the filter criteria is changed.
Changed Occurs when the Freezable or an object it contains is modified. Inherited from Freezable.
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