Class RadFilterView

Displays a hierarchical collection of filter options.

Inheritance
System.Object
RadControl
RadFilterView
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadFilterView : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadFilterView()

Initializes a new instance of the RadFilterView control.

Declaration
public RadFilterView()

Properties

AssociatedControl

Gets or sets the associated control.

Declaration
public IFilterable AssociatedControl { get; set; }
Property Value
IFilterable

AutoGenerateCategories

Gets or sets a value indicating whether to auto generate categories when the DataSource property is set.

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

A value indicating whether to auto generate categories.

Categories

Gets the categories collection.

Declaration
public RadItemOwnerGenericCollection<BaseFilterViewCategoryElement> Categories { get; }
Property Value
RadItemOwnerGenericCollection<BaseFilterViewCategoryElement>

CategoriesFactory

Gets or sets the factory responsible for creating category elements.

Declaration
public FilterViewCategoriesFactory CategoriesFactory { get; set; }
Property Value
FilterViewCategoriesFactory

DataSource

Gets or sets the data source.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Expression

Gets the filter expression.

Declaration
public string Expression { get; }
Property Value
System.String

FilterDescriptors

Gets the filter descriptors collection.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

FilteringMode

Gets or sets the filtering mode.

Declaration
public FilteringMode FilteringMode { get; set; }
Property Value
FilteringMode

FilterViewElement

Gets the FilterViewElement.

Declaration
public RadFilterViewElement FilterViewElement { get; }
Property Value
RadFilterViewElement

LoadCategoriesAsync

Gets or sets a value indicating whether to generate the category elements asynchronously.

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

RadContextMenu

Gets or sets the context menu.

Declaration
public virtual RadContextMenuDropDown RadContextMenu { get; set; }
Property Value
RadContextMenuDropDown

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

Methods

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateFilterViewElement()

Declaration
protected virtual RadFilterViewElement CreateFilterViewElement()
Returns
RadFilterViewElement

Events

CategoryCreated

An event that occurs when a category is created and populated with items. This event is suitable to modify properties of the Category element.

Declaration
public event FilterViewCategoryCreatedEventHandler CategoryCreated
Event Type
FilterViewCategoryCreatedEventHandler

CategoryCreating

An event that occurs when a category is created and is about to be populated with items. This event is suitable to modify the values collection(sort/add/remove/reorder) or modify/replace the Category element.

Declaration
public event FilterViewCategoryCreatingEventHandler CategoryCreating
Event Type
FilterViewCategoryCreatingEventHandler

ContextMenuClosed

Occurs when the context menu is closed.

Declaration
public event EventHandler ContextMenuClosed
Event Type
System.EventHandler

ContextMenuClosing

Occurs when the context menu is closing.

Declaration
public event CancelEventHandler ContextMenuClosing
Event Type
System.ComponentModel.CancelEventHandler

ContextMenuItemClick

Occurs when an item in the context menu is clicked.

Declaration
public event HandledEventHandler ContextMenuItemClick
Event Type
System.ComponentModel.HandledEventHandler

ContextMenuOpened

Occurs when the context menu is opened.

Declaration
public event EventHandler ContextMenuOpened
Event Type
System.EventHandler

ContextMenuOpening

Occurs when the context menu is opening.

Declaration
public event CancelEventHandler ContextMenuOpening
Event Type
System.ComponentModel.CancelEventHandler

FilterChanged

Occurs when the filter is changed.

Declaration
public event FilterChangedEventHandler FilterChanged
Event Type
FilterChangedEventHandler

Extension Methods