ASPxDashboardViewer.SingleFilterDefaultValue Event
OBSOLETE
Use MasterFilterDefaultValues instead.
Allows you to specify a default filter value for the Single Master Filter.
Namespace: DevExpress.DashboardWeb
Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll
Declaration
[Obsolete("Use MasterFilterDefaultValues instead.")]
[Browsable(false)]
public event SingleFilterDefaultValueEventHandler SingleFilterDefaultValue
Event Data
The SingleFilterDefaultValue event's data class is SingleFilterDefaultValueEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
DashboardItemName | Gets the name of the dashboard item for which the SingleFilterDefaultValue event was raised. |
FilterValue | Gets the default filter value. |
The event data class exposes the following methods:
Method | Description |
---|---|
GetAvailableSelections() | Returns records identifying elements that can be selected in the current state of the master filter item. |
SetFilterValue(DashboardDataRow) | Specifies the default filter value. |
SetFilterValue(IList) | Specifies the default filter value. |
Remarks
The SingleFilterDefaultValue event allows you to specify a default filter value for the Single Master Filter. It is raised for each master filter item with the enabled Single Master Filter mode.
The SingleFilterDefaultValueEventArgs.DashboardItemName property allows you to obtain the dashboard item name for which the event was raised. Use the SingleFilterDefaultValueEventArgs.FilterValue property to specify the required default filter value.