ASPxTreeList.ProcessColumnAutoFilter Event
Enables you to apply custom filter criteria when filter row is in the Auto mode.
Namespace: DevExpress.Web.ASPxTreeList
Assembly: DevExpress.Web.ASPxTreeList.v24.1.dll
NuGet Package: DevExpress.Web
Declaration
Event Data
The ProcessColumnAutoFilter event's data class is ASPxTreeListAutoFilterEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Column | Gets the data column to be filtered. |
| Criteria | Gets the applied filter criteria. Inherited from GridAutoFilterEventArgs. |
| Kind | Gets a value specifying which action should be performed within the corresponding event handler. Inherited from GridAutoFilterEventArgs. |
| Value | Gets or sets a value that is the custom text displayed within the filter row cell. Inherited from GridAutoFilterEventArgs. |
Remarks
End-users can build simple filter criteria and apply them using the Filter Row, which can work in either Auto or OnClick mode (based on the TreeListSettingsBehavior.FilterRowMode property value). When the filter works in Auto mode, you can use the ProcessColumnAutoFilter event handler to perform any actions before the filter criterion is applied.
This event is raised twice and enables you to perform the following actions.
- Provide custom filter criteria.
- Specify text displayed within the auto-filter row cell.
When the event parameter’s GridAutoFilterEventArgs.Kind property returns GridViewAutoFilterEventKind.CreateCriteria, you can provide custom filter criteria with the GridAutoFilterEventArgs.Criteria property.
Note
When handling the ProcessColumnAutoFilter event, you should apply filter criteria only to the column that is filtered.
When the GridAutoFilterEventArgs.Kind property returns GridViewAutoFilterEventKind.ExtractDisplayText, you can provide custom text displayed within the filter row cell with the GridAutoFilterEventArgs.Value property.
In the OnClick mode, use the ASPxTreeList.ProcessOnClickRowFilter event handler to perform any actions before the filter criteria are applied.
Note
Online Demos Refer to the Tree List - Data Filter Row(Web Forms) online demo to review how to filter Tree List data nodes using the Filter Row.