Class
RadDataFilter

Provides a user interface for creating filtering expressions.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Data.dll

Syntax:

cs-api-definition
[TelerikToolboxCategory("Data")]
public class RadDataFilter : Control

Inheritance: objectRadDataFilter

Constructors

RadDataFilter()

Initializes a new instance of the RadDataFilter class.

Declaration

cs-api-definition
public RadDataFilter()

Fields

AutoGenerateItemPropertyDefinitionsProperty

Identifies the AutoGenerateItemPropertyDefinitions dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AutoGenerateItemPropertyDefinitionsProperty

Field Value

DependencyProperty

CanUserCreateCompositeFiltersProperty

Identifies the CanUserCreateCompositeFilters dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanUserCreateCompositeFiltersProperty

Field Value

DependencyProperty

EditorTemplateSelectorProperty

Identifies the EditorTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty EditorTemplateSelectorProperty

Field Value

DependencyProperty

SourceProperty

Identifies the Source dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty SourceProperty

Field Value

DependencyProperty

ViewModelProperty

Identifies the ViewModel dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ViewModelProperty

Field Value

DependencyProperty

Properties

AutoGenerateItemPropertyDefinitions

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

Declaration

cs-api-definition
public bool AutoGenerateItemPropertyDefinitions { get; set; }

Property Value

bool

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

cs-api-definition
public bool CanUserCreateCompositeFilters { get; set; }

Property Value

bool

true if filter composition is disabled; otherwise, false.

EditorTemplateSelector

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

Declaration

cs-api-definition
public DataTemplateSelector EditorTemplateSelector { get; set; }

Property Value

DataTemplateSelector

FilterDescriptors

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

Declaration

cs-api-definition
public CompositeFilterDescriptorCollection FilterDescriptors { get; }

Property Value

CompositeFilterDescriptorCollection

The filter descriptors.

FilteredSource

Gets the filtered source.

Declaration

cs-api-definition
public IEnumerable FilteredSource { get; }

Property Value

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

cs-api-definition
public ItemPropertyDefinitionCollection ItemPropertyDefinitions { get; }

Property Value

ItemPropertyDefinitionCollection

The collection of ItemPropertyDefinitions.

Source

Gets or sets the data collection that the RadDataFilter filters.

Declaration

cs-api-definition
public IEnumerable Source { get; set; }

Property Value

IEnumerable

The data collection associated with this filter control.

ViewModel

Gets or sets the view model.

Declaration

cs-api-definition
public FilterViewModel ViewModel { get; }

Property Value

FilterViewModel

The view model.

Methods

EndInit()

Indicates that the initialization process for the element is complete.

Declaration

cs-api-definition
public override void EndInit()

Exceptions

InvalidOperationException

was called without having previously been called on the element.

OnAutoGeneratingItemPropertyDefinition(DataFilterAutoGeneratingItemPropertyDefinitionEventArgs)

Raises the AutoGeneratingItemPropertyDefinition event.

Declaration

cs-api-definition
protected virtual void OnAutoGeneratingItemPropertyDefinition(DataFilterAutoGeneratingItemPropertyDefinitionEventArgs e)

Parameters

e

DataFilterAutoGeneratingItemPropertyDefinitionEventArgs

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

The type-specific AutomationPeer implementation.

OnEditorCreated(EditorCreatedEventArgs)

Raises the EditorCreated event.

Declaration

cs-api-definition
protected virtual void OnEditorCreated(EditorCreatedEventArgs e)

Parameters

e

EditorCreatedEventArgs

OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs)

Raises the FilterOperatorsLoading event.

Declaration

cs-api-definition
protected virtual void OnFilterOperatorsLoading(FilterOperatorsLoadingEventArgs e)

Parameters

e

FilterOperatorsLoadingEventArgs

OnInitialized(EventArgs)

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

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

ToString()

Returns a string that represents this instance.

Declaration

cs-api-definition
public override string ToString()

Returns

string

A string that represents this instance.

Events

AutoGeneratingItemPropertyDefinition

Occurs when RadDataFilter auto-generates item property definitions.

Declaration

cs-api-definition
public event EventHandler<DataFilterAutoGeneratingItemPropertyDefinitionEventArgs> AutoGeneratingItemPropertyDefinition

Event Value

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

cs-api-definition
public event EventHandler<EditorCreatedEventArgs> EditorCreated

Event Value

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

cs-api-definition
public event EventHandler<FilterOperatorsLoadingEventArgs> FilterOperatorsLoading

Event Value

EventHandler<FilterOperatorsLoadingEventArgs>