Class RadDataFilter

Provides a user interface for creating filtering expressions.

Inheritance
System.Object
RadDataFilter
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Data.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadDataFilter : Control, IThemable

Constructors

RadDataFilter()

Initializes a new instance of the RadDataFilter class.

Declaration
public RadDataFilter()

Fields

AutoGenerateItemPropertyDefinitionsProperty

Identifies the AutoGenerateItemPropertyDefinitions dependency property.

Declaration
public static readonly DependencyProperty AutoGenerateItemPropertyDefinitionsProperty
Field Value
System.Windows.DependencyProperty

CanUserCreateCompositeFiltersProperty

Identifies the CanUserCreateCompositeFilters dependency property.

Declaration
public static readonly DependencyProperty CanUserCreateCompositeFiltersProperty
Field Value
System.Windows.DependencyProperty

EditorTemplateSelectorProperty

Identifies the EditorTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty EditorTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

SourceProperty

Identifies the Source dependency property.

Declaration
public static readonly DependencyProperty SourceProperty
Field Value
System.Windows.DependencyProperty

ViewModelProperty

Identifies the ViewModel dependency property.

Declaration
public static readonly DependencyProperty ViewModelProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoGenerateItemPropertyDefinitions

Gets or sets a value indicating whether item property definitions will be auto-generated based on the Source.

Declaration
public bool AutoGenerateItemPropertyDefinitions { get; set; }
Property Value
System.Boolean

true if item property definitions will be auto-generated; otherwise, false.

CanUserCreateCompositeFilters

Gets or sets a value indicating whether the user can create composite filters. This property is typically used when filtering a DomainDataSource, which does not support filter composition.

Declaration
public bool CanUserCreateCompositeFilters { get; set; }
Property Value
System.Boolean

true if filter composition is disabled; otherwise, false.

EditorTemplateSelector

Gets or sets the data template selector for the filter editors.

Declaration
public DataTemplateSelector EditorTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

FilterDescriptors

Gets a collection of FilterDescriptor objects used to filter the items collection of this instance.

Declaration
public CompositeFilterDescriptorCollection FilterDescriptors { get; }
Property Value
CompositeFilterDescriptorCollection

The filter descriptors.

FilteredSource

Gets the filtered source.

Declaration
public IEnumerable FilteredSource { get; }
Property Value
System.Collections.IEnumerable

The filtered source.
Remarks

Binding the ItemsSource property of an ItemsControl to the FilteredSource property will enable filtering for this control through RadDataFilter.

ItemPropertyDefinitions

Gets a collection of ItemPropertyDefinition's describing the properties displayed by RadDataFilter.

Declaration
public ItemPropertyDefinitionCollection ItemPropertyDefinitions { get; }
Property Value
ItemPropertyDefinitionCollection

The collection of ItemPropertyDefinitions.

Source

Gets or sets the data collection that the RadDataFilter filters.

Declaration
public IEnumerable Source { get; set; }
Property Value
System.Collections.IEnumerable

The data collection associated with this filter control.

ViewModel

Gets or sets the view model.

Declaration
public FilterViewModel ViewModel { get; }
Property Value
FilterViewModel

The view model.

Methods

EndInit()

Indicates that the initialization process for the element is complete.

Declaration
public override void EndInit()
Exceptions
System.InvalidOperationException

System.Windows.FrameworkElement.EndInit was called without System.Windows.FrameworkElement.BeginInit having previously been called on the element.

OnAutoGeneratingItemPropertyDefinition(DataFilterAutoGeneratingItemPropertyDefinitionEventArgs)

Raises the AutoGeneratingItemPropertyDefinition event.

Declaration
protected virtual void OnAutoGeneratingItemPropertyDefinition(DataFilterAutoGeneratingItemPropertyDefinitionEventArgs e)
Parameters
DataFilterAutoGeneratingItemPropertyDefinitionEventArgs e

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnEditorCreated(EditorCreatedEventArgs)

Raises the EditorCreated event.

Declaration
protected virtual void OnEditorCreated(EditorCreatedEventArgs e)
Parameters
EditorCreatedEventArgs e

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

Raises the FilterOperatorsLoading event.

Declaration
protected virtual void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters
FilterOperatorsLoadingEventArgs e

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
System.String

A System.String that represents this instance.

Events

AutoGeneratingItemPropertyDefinition

Occurs when RadDataFilter auto-generates item property definitions.

Declaration
public event EventHandler<DataFilterAutoGeneratingItemPropertyDefinitionEventArgs> AutoGeneratingItemPropertyDefinition
Event Type
System.EventHandler<DataFilterAutoGeneratingItemPropertyDefinitionEventArgs>

EditorCreated

Occurs when a filter editor has been created and before it is added to the visual tree. Use this event if you want to customize the editor.

Declaration
public event EventHandler<EditorCreatedEventArgs> EditorCreated
Event Type
System.EventHandler<EditorCreatedEventArgs>

FilterOperatorsLoading

Occurs before the filter operators are loaded. Use this event if you want to remove one or more filter operators from the list.

Declaration
public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading
Event Type
System.EventHandler<FilterOperatorsLoadingEventArgs>

Extension Methods