ASPxDashboardViewer.CustomFilterExpression Event
Allows you to include WHERE clauses into DashboardSqlDataSource queries.
Namespace: DevExpress.DashboardWeb
Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll
Declaration
Event Data
The CustomFilterExpression event's data class is CustomFilterExpressionWebEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
DashboardId | Gets the identifier of the current dashboard. |
DataSourceComponentName | Get the data source name, used in code to identify the data source’s object, for which the event has been raised. Inherited from CustomFilterExpressionEventArgs. |
DataSourceName | Gets the name of the data source for which the event has been raised. Inherited from CustomFilterExpressionEventArgs. |
FilterExpression | Gets or sets the filter expression that defines a WHERE clause included in the SQL query. Inherited from CustomFilterExpressionEventArgs. |
QueryName | Gets the name of the query for which the event was raised. Inherited from CustomFilterExpressionEventArgs. |
TableName | Indicates the name of a data table to which the CustomFilterExpressionEventArgs.FilterExpression applies. Inherited from CustomFilterExpressionEventArgs. |
Remarks
The CustomFilterExpression event fires for each SelectQuery within DashboardSqlDataSource (the SqlDataSource.Queries property) and allows you to include a WHERE clause to a query at runtime using the CustomFilterExpressionEventArgs.FilterExpression event parameter. If filtering is already applied to the SQL query, CustomFilterExpressionEventArgs.FilterExpression returns a corresponding filter criteria.
Note
The CustomFilterExpression event is not raised for custom SQL queries and stored procedures.