New to Telerik UI for WPFStart a free 30-day trial

Provides a user interface for creating filtering expressions.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Data.dll

Syntax:

C#
[TelerikToolboxCategory("Data")]
public class RadDataFilter : Control

Inheritance: objectRadDataFilter

Constructors

Initializes a new instance of the RadDataFilter class.

C#
public RadDataFilter()

Fields

Identifies the AutoGenerateItemPropertyDefinitions dependency property.

C#
public static readonly DependencyProperty AutoGenerateItemPropertyDefinitionsProperty

Identifies the CanUserCreateCompositeFilters dependency property.

C#
public static readonly DependencyProperty CanUserCreateCompositeFiltersProperty

Identifies the EditorTemplateSelector dependency property.

C#
public static readonly DependencyProperty EditorTemplateSelectorProperty

SourceProperty

DependencyProperty

Identifies the Source dependency property.

C#
public static readonly DependencyProperty SourceProperty

ViewModelProperty

DependencyProperty

Identifies the ViewModel dependency property.

C#
public static readonly DependencyProperty ViewModelProperty

Properties

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

C#
public bool AutoGenerateItemPropertyDefinitions { get; set; }
Property Value:

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

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.

C#
public bool CanUserCreateCompositeFilters { get; set; }
Property Value:

true if filter composition is disabled; otherwise, false.

EditorTemplateSelector

DataTemplateSelector

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

C#
public DataTemplateSelector EditorTemplateSelector { get; set; }

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

C#
public CompositeFilterDescriptorCollection FilterDescriptors { get; }
Property Value:

The filter descriptors.

Gets the filtered source.

C#
public IEnumerable FilteredSource { get; }
Property Value:

The filtered source.

Remarks:

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

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

C#
public ItemPropertyDefinitionCollection ItemPropertyDefinitions { get; }
Property Value:

The collection of ItemPropertyDefinitions.

Gets or sets the data collection that the RadDataFilter filters.

C#
public IEnumerable Source { get; set; }
Property Value:

The data collection associated with this filter control.

Gets or sets the view model.

C#
public FilterViewModel ViewModel { get; }
Property Value:

The view model.

Methods

Indicates that the initialization process for the element is complete.

C#
public override void EndInit()
Exceptions:

InvalidOperationException

was called without having previously been called on the element.

Raises the AutoGeneratingItemPropertyDefinition event.

C#
protected virtual void OnAutoGeneratingItemPropertyDefinition(DataFilterAutoGeneratingItemPropertyDefinitionEventArgs e)
Parameters:eDataFilterAutoGeneratingItemPropertyDefinitionEventArgs

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

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

Raises the EditorCreated event.

C#
protected virtual void OnEditorCreated(EditorCreatedEventArgs e)
Parameters:eEditorCreatedEventArgs

Raises the FilterOperatorsLoading event.

C#
protected virtual void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)
Parameters:eFilterOperatorsLoadingEventArgs

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Resets the theme.

C#
public void ResetTheme()

Returns a string that represents this instance.

C#
public override string ToString()
Returns:

string

A string that represents this instance.

Events

Occurs when RadDataFilter auto-generates item property definitions.

C#
public event EventHandler<DataFilterAutoGeneratingItemPropertyDefinitionEventArgs> AutoGeneratingItemPropertyDefinition

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.

C#
public event EventHandler<EditorCreatedEventArgs> EditorCreated

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

C#
public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading