Class

RadFilterViewElement

Initializes a new instance of the RadFilterViewElement class with default settings and creates the required internal components.

Declaration

public RadFilterViewElement()

Gets or sets the associated filterable object that implements the IFilterable interface. When set, the filter view will automatically bind to its data source and apply filters to it.

Declaration

public IFilterable AssociatedFilterable { get; set; }

Property Value

Gets or sets a value indicating whether filter categories should be automatically generated based on the properties of the data source.

Declaration

public bool AutoGenerateCategories { get; set; }

Property Value

Gets the collection of filter category elements that are currently displayed in the filter view.

Declaration

public RadItemOwnerGenericCollection<BaseFilterViewCategoryElement> Categories { get; }

Property Value

Gets or sets the factory responsible for creating filter category elements based on data property types and names.

Declaration

public FilterViewCategoriesFactory CategoriesFactory { get; set; }

Property Value

Gets or sets the context menu that is displayed when right-clicking on filter categories. The menu provides options for clearing filters.

Declaration

public RadContextMenuDropDown ContextMenu { get; set; }

Property Value

Gets or sets the data source for the filter view. The data source is used to generate filter categories automatically based on the data properties.

Declaration

public object DataSource { get; set; }

Property Value

Gets the stack layout panel that contains all filter category elements.

Declaration

public StackLayoutPanel ElementsPanel { get; }

Property Value

Gets the filter expression as a string representation of all applied filters combined with the current logical operator.

Declaration

public string Expression { get; }

Property Value

Gets the collection of filter descriptors that represent the currently applied filters. Each descriptor corresponds to a filter applied by a category.

Declaration

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets the filtering mode that determines when filters are applied to the associated filterable object.

Declaration

public FilteringMode FilteringMode { get; set; }

Property Value

Gets the horizontal scrollbar element used for horizontal scrolling when the content exceeds the available width.

Declaration

public RadScrollBarElement HorizontalScrollBar { get; }

Property Value

Gets or sets a value indicating whether filter categories should be loaded asynchronously to prevent blocking the UI thread during data processing.

Declaration

public bool LoadCategoriesAsync { get; set; }

Property Value

Gets the vertical scrollbar element used for vertical scrolling when the content exceeds the available height.

Declaration

public RadScrollBarElement VerticalScrollBar { get; }

Property Value

Applies a filter descriptor programmatically to the appropriate filter category. Each category supports specific filter operators based on the data type. Text and CheckedDropDownList categories support IsEqualTo, IsContainedIn and IsNull. DropDownList categories support IsEqualTo and IsNull. Boolean categories support IsEqualTo and IsNotEqualTo. Numeric categories support IsGreaterThan, IsGreaterThanOrEqualTo, IsLessThan, IsLessThanOrEqualTo and IsEqualTo. DateTime categories support IsGreaterThan, IsGreaterThanOrEqualTo, IsLessThan, IsLessThanOrEqualTo and IsEqualTo.

Declaration

public virtual bool ApplyFilterDescriptor(FilterDescriptor filterDescriptor)

Parameters

Returns

Arranges the RadFilterViewElement and its child elements to their final positions and sizes. This method positions the main content panel and scrollbars according to the available space and scrollbar visibility.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Handles filter changes from filter categories and updates the filter descriptors collection accordingly.

Declaration

public void CategoryFilterChanged(IFilterViewCategory categoryItem)

Parameters

Implements IFilterViewCategoriesOwner.CategoryFilterChanged(IFilterViewCategory)

Clears all applied filters from all filter categories, resetting the filter view to its initial state.

Declaration

public virtual void ClearAllFilters()

Creates a new binding context for data binding operations.

Declaration

protected virtual BindingContext CreateBindingContext()

Returns

Creates child elements including the main panel, scrollbars, categories collection, and context menu.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates and returns a new context menu dropdown for the filter view.

Declaration

protected virtual RadContextMenuDropDown CreateContextMenu()

Returns

Creates and returns a new horizontal scrollbar element for the filter view.

Declaration

protected virtual RadScrollBarElement CreateHorizontalScrollBarElement()

Returns

Creates and returns a new list source for managing filter view data items.

Declaration

protected virtual RadListSource<FilterViewDataItem> CreateListSource()

Returns

Creates and returns a new stack panel that will contain all filter category elements.

Declaration

protected virtual StackLayoutPanel CreateStackPanel()

Returns

Creates and returns a new vertical scrollbar element for the filter view.

Declaration

protected virtual RadScrollBarElement CreateVerticalScrollBarElement()

Returns

Releases managed resources used by the RadFilterViewElement including background worker, list source, filter descriptors, and context menu items.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Initializes filter categories by processing the data source and creating appropriate category elements for each data property.

Declaration

public virtual void InitializeCategories()

Initializes filter categories asynchronously using a background worker to prevent blocking the UI thread.

Declaration

public void InitializeCategoriesAsync()

Initializes the default context menu items including clear category filter and clear all filters options.

Declaration

protected virtual void InitializeDropDownMenu()

Initializes the fields and sets default property values for the RadFilterViewElement.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Measures the space required by the RadFilterViewElement by calculating the desired size based on the content panel and visible scrollbars. This method is called by the layout system to determine space requirements.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Raises the CategoryCreated event after a filter category has been successfully created and populated with items.

Declaration

protected virtual void OnCategoryCreated(FilterViewCategoryCreatedEventArgs args)

Parameters

Raises the CategoryCreating event, allowing modification of the values collection or replacement of the category element before it is finalized.

Declaration

protected virtual void OnCategoryCreating(FilterViewCategoryCreatingEventArgs args)

Parameters

Raises the ContextMenuClosed event after the context menu has been closed and is no longer visible.

Declaration

protected virtual void OnContextMenuClosed()

Raises the ContextMenuClosing event, allowing cancellation of the context menu closing operation.

Declaration

protected virtual void OnContextMenuClosing(CancelEventArgs args)

Parameters

Handles context menu item clicks and provides default behavior for built-in menu items while allowing custom handling through the ContextMenuItemClick event.

Declaration

protected virtual void OnContextMenuItemClick(object sender, EventArgs e)

Parameters

Raises the ContextMenuOpened event after the context menu has been successfully displayed.

Declaration

protected virtual void OnContextMenuOpened()

Raises the ContextMenuOpening event, allowing cancellation or modification of the context menu before it is displayed.

Declaration

protected virtual void OnContextMenuOpening(CancelEventArgs args)

Parameters

Raises the FilterChanged event and updates the associated filterable object when a filter is modified.

Declaration

protected virtual void OnFilterChanged(FilterChangedEventArgs args)

Parameters

Handles mouse down events to initiate mouse panning functionality for scrolling through filter categories.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Handles mouse move events to perform mouse panning for scrolling when the mouse button is held down.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides LightVisualElement.OnMouseMove(MouseEventArgs)

Handles mouse up events to complete the mouse panning operation and reset panning state.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseUp(MouseEventArgs)

Handles mouse wheel events to provide vertical and horizontal scrolling support. Vertical scrolling is the default behavior, while holding Shift enables horizontal scrolling.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadElement.OnMouseWheel(MouseEventArgs)

Identifies and creates filter category elements based on the properties of the current data source.

Declaration

protected virtual void PrepareCategories()

Processes and populates filter categories with data by extracting unique values from the data source for each category property.

Declaration

protected virtual void ProcessCategoryData()

Processes mouse wheel scrolling by calculating the appropriate scroll amount and updating the specified scrollbar value.

Declaration

protected virtual void ProcessMouseWheelScroll(MouseEventArgs e, RadScrollBarElement scrollBar)

Parameters

Removes a filter descriptor by clearing the filter of the category that matches the PropertyName of the specified filter descriptor.

Declaration

public virtual void RemoveFilterDescriptor(FilterDescriptor filterDescriptor)

Parameters

Sets up a filter category by firing the CategoryCreating and CategoryCreated events and populating it with filter items based on the provided values.

Declaration

public void SetupCategory(BaseFilterViewCategoryElement category, ICollection<object> values)

Parameters

Determines whether a child element should be arranged during the layout arrangement pass. The main panel and scrollbars are excluded from standard child arrangement as they require custom positioning.

Declaration

protected override bool ShouldArrangeChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldArrangeChild(RadElement)

Determines whether a child element should be measured during the layout measurement pass. The main panel and scrollbars are excluded from standard child measurement as they are handled specially.

Declaration

protected override bool ShouldMeasureChild(RadElement child)

Parameters

Returns

Overrides RadElement.ShouldMeasureChild(RadElement)

Displays the context menu at the specified location for the given filter category.

Declaration

public virtual void ShowContextMenu(IFilterViewCategory category, Point location)

Parameters

Implements IFilterViewCategoriesOwner.ShowContextMenu(IFilterViewCategory, Point)

Updates the filter descriptors collection of the associated filterable object with the current filters applied to the filter view categories.

Declaration

protected virtual void UpdateAssociatedFilterable()

Updates the content of a filter category by refreshing its filter items based on the current data source.

Declaration

public void UpdateCategory(IFilterViewCategory category)

Parameters

Implements IFilterViewCategoriesOwner.UpdateCategory(IFilterViewCategory)

Updates the visibility and value ranges of both horizontal and vertical scrollbars based on the current content size.

Declaration

public void UpdateScrollbars()

Occurs when a filter category has been created and populated with items. This event is suitable for modifying properties or appearance of the finalized category element.

Declaration

public event FilterViewCategoryCreatedEventHandler CategoryCreated

Event Value

Occurs when a filter category is about to be created and populated with items. This event allows modification of the values collection or replacement of the category element before it is finalized.

Declaration

public event FilterViewCategoryCreatingEventHandler CategoryCreating

Event Value

Occurs when the context menu has been closed and is no longer visible to the user.

Declaration

public event EventHandler ContextMenuClosed

Event Value

Occurs when the context menu is about to be closed. This event allows cancellation of the context menu closing or execution of cleanup operations.

Declaration

public event CancelEventHandler ContextMenuClosing

Event Value

Occurs when an item in the context menu is clicked by the user. This event allows custom handling of context menu item clicks before the default behavior is executed.

Declaration

public event HandledEventHandler ContextMenuItemClick

Event Value

Occurs when the context menu has been opened and is now visible to the user.

Declaration

public event EventHandler ContextMenuOpened

Event Value

Occurs when the context menu is about to be opened. This event allows cancellation of the context menu display or modification of menu items before showing.

Declaration

public event CancelEventHandler ContextMenuOpening

Event Value

Occurs when a filter is changed, added, or removed from any category in the filter view. This event is raised after the filter has been applied and provides access to both the affected category and the filter descriptor.

Declaration

public event FilterChangedEventHandler FilterChanged

Event Value