FilterController.CustomGetFilters Event

Occurs when the FilterController is activated. Allows you to specify the Application Model's Views | <ListView> | Filters node, containing the filter definitions to be used by the FilterController's SetFilter Action for the currently processed List View.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v18.1.dll

Declaration

public event EventHandler<CustomGetFiltersEventArgs> CustomGetFilters
Public Event CustomGetFilters As EventHandler(Of CustomGetFiltersEventArgs)

The event handler receives an argument of the CustomGetFiltersEventArgs type. The CustomGetFiltersEventArgs properties provide information specific to this event.

The FilterController exposes the FilterAction described in the FilterController.SetFilterAction and Filter List Views help topics. The CustomGetFiltersEventArgs.Filters parameter refers to an Application Model node. All changes of this node are persisted to the user's Model Differences, so the CustomGetFilters event should not be used to modify this node. The event can be used only to conditionally switch the set of predefined filters by assigning the required Application Model's Filters node to the Filters parameter. Note that the value of the currently selected filter's Id property is saved to the specified node's CurrentFilterID property.

See Also