RadFilterView
Displays a hierarchical collection of filter options that can be used to filter data sources and controls.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Data Controls")]
public class RadFilterView : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadFilterView...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadFilterView control.
public RadFilterView()Properties
Gets or sets the control that will be filtered by this RadFilterView.
public IFilterable AssociatedControl { get; set; }When set, the filter view will automatically apply filter descriptors to the associated control's FilterDescriptors collection. The associated control must implement the IFilterable interface.
Gets or sets a value indicating whether to automatically generate filter categories when the DataSource property is set.
public bool AutoGenerateCategories { get; set; }When true, the filter view will examine the data source properties and create appropriate filter categories automatically. When false, categories must be manually added to the Categories collection.
Gets the collection of filter categories displayed in the filter view.
public RadItemOwnerGenericCollection<BaseFilterViewCategoryElement> Categories { get; }Categories represent different filter criteria that can be applied to the data. Each category corresponds to a data field and provides appropriate filtering UI based on the data type.
Gets or sets the factory responsible for creating category elements.
public FilterViewCategoriesFactory CategoriesFactory { get; set; }The factory determines how filter categories are created based on data types and properties. Custom factories can be used to provide specialized filtering UI for specific data types.
Gets or sets the data source for automatic category generation.
public object DataSource { get; set; }When a data source is assigned and AutoGenerateCategories is true, the filter view will automatically generate filter categories based on the data source properties. The data source can be any enumerable collection, DataTable, or data-bound object.
Gets the default size of the control.
protected override Size DefaultSize { get; }Overrides:
Gets the current filter expression as a string representation.
public string Expression { get; }The expression represents the combined filter criteria from all active categories in a format that can be used with expression parsers or for display purposes.
Gets the collection of filter descriptors that represent the current filter state.
public FilterDescriptorCollection FilterDescriptors { get; }Filter descriptors contain the actual filtering logic including field names, operators, and values. These descriptors can be applied to data sources or controls that support filtering.
Gets or sets the filtering mode that determines when filters are applied.
public FilteringMode FilteringMode { get; set; }OnFilterChanged applies filters immediately when they are changed. Other modes may require explicit action to apply the filters.
Gets the main FilterViewElement that contains all the filtering functionality.
public RadFilterViewElement FilterViewElement { get; }Gets or sets a value indicating whether category elements are generated asynchronously.
public bool LoadCategoriesAsync { get; set; }Asynchronous loading improves UI responsiveness when working with large data sources by generating filter categories on a background thread.
Gets or sets the context menu displayed when right-clicking on filter categories.
public virtual RadContextMenuDropDown RadContextMenu { get; set; }The context menu typically provides options to clear filters, modify filter settings, or perform other filter-related actions.
Methods
Creates the child elements of the control.
protected override void CreateChildItems(RadElement parent)The parent element to which the child elements will be added.
Overrides:
Creates the main filter view element.
protected virtual RadFilterViewElement CreateFilterViewElement()A new instance of RadFilterViewElement.
Events
An event that occurs when a category is created and populated with items.
public event FilterViewCategoryCreatedEventHandler CategoryCreatedThis event is suitable for modifying properties of the category element after it has been created and populated. It allows final customization of the category's appearance and behavior.
An event that occurs when a category is created and is about to be populated with items.
public event FilterViewCategoryCreatingEventHandler CategoryCreatingThis event is suitable for modifying the values collection (sort/add/remove/reorder) or replacing the category element entirely. It allows customization of the category before it becomes visible to the user.
Occurs when the context menu is closed.
public event EventHandler ContextMenuClosedThis event is raised after the context menu has been closed and is no longer visible to the user.
Occurs when the context menu is closing.
public event CancelEventHandler ContextMenuClosingThis event allows handling of context menu closing and optionally preventing the closure. Set the Cancel property of the event arguments to prevent the menu from closing.
Occurs when an item in the context menu is clicked.
public event HandledEventHandler ContextMenuItemClickThis event allows custom handling of context menu actions before the default processing occurs. Set the Handled property of the event arguments to prevent default processing.
Occurs when the context menu is opened.
public event EventHandler ContextMenuOpenedThis event is raised after the context menu has been successfully opened and displayed to the user.
Occurs when the context menu is opening.
public event CancelEventHandler ContextMenuOpeningThis event allows customization of the context menu before it is displayed to the user. Set the Cancel property of the event arguments to prevent the menu from opening.
Occurs when the filter is changed in any of the filter categories.
public event FilterChangedEventHandler FilterChangedThis event is raised whenever a filter value is modified, added, or removed from any category. It provides access to the changed category and the resulting filter descriptor.