ASPxGridView.ProcessOnClickRowFilter Event
Enables you to apply custom filter criteria when the filter row is in the OnClick mode.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v23.2.dll
NuGet Package: DevExpress.Web
Declaration
Event Data
The ProcessOnClickRowFilter event's data class is ASPxGridViewOnClickRowFilterEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Criteria | Gets the applied filter criteria. Inherited from GridOnClickRowFilterEventArgs. |
| Kind | Gets or sets a value specifying which action should be performed within the corresponding event handler. Inherited from GridOnClickRowFilterEventArgs. |
| Values | Gets values that are the custom texts displayed within the filter row cells. Inherited from GridOnClickRowFilterEventArgs. |
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 ASPxGridViewBehaviorSettings.FilterRowMode property value). When the filter works in OnClick mode, you can use the ProcessOnClickRowFilter event handler to perform any actions before the filter criteria are 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 GridOnClickRowFilterEventArgs.Kind property returns GridViewAutoFilterEventKind.CreateCriteria, you can provide custom filter criteria with the GridOnClickRowFilterEventArgs.Criteria property.
Note
When handling the ProcessOnClickRowFilter event, you should apply filter criteria only to the column that is filtered.
When the GridOnClickRowFilterEventArgs.Kind property returns GridViewAutoFilterEventKind.ExtractDisplayText, you can provide custom text displayed within the filter row cells with the GridOnClickRowFilterEventArgs.Values property.
In the OnClick mode, use the ASPxGridView.ProcessColumnAutoFilter event handler to perform any actions before the filter criteria are applied.