DashboardViewer.MasterFilterSet Event
Occurs when an end user changes the state of the master filter.
Namespace: DevExpress.DashboardWin
Assembly: DevExpress.Dashboard.v24.1.Win.dll
NuGet Package: DevExpress.Win.Dashboard
Declaration
Event Data
The MasterFilterSet event's data class is MasterFilterSetEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| DashboardItemName | Gets the name of the dashboard item. |
| SelectedRange | Gets the selected range in the Range Filter dashboard item. |
| SelectedValues | Gets currently selected records in the master filter item. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| IsNullValue(Object) | Returns whether the specified value is DashboardSpecialValues.NullValue. |
| IsOthersValue(Object) | Returns whether the specified value is DashboardSpecialValues.OthersValue. |
Remarks
The MasterFilterSet event occurs when an end-user changes the state of the master filter.
The MasterFilterSetEventArgs class exposes the MasterFilterSetEventArgs.DashboardItemName property that allows you to determine the name of the master filter item which causes the event.
Use the MasterFilterSetEventArgs.SelectedValues property to obtain values of selected elements in the master filter item. To determine the selected range in the Range Filter dashboard item, use the MasterFilterSetEventArgs.SelectedRange property.
Note
The MasterFilterSetEventArgs.SelectedValues property returns the DashboardSpecialValues.NullValue or DashboardSpecialValues.OthersValue values instead of null or “Others” values, respectively.
Tip
To reduce the application load time and decrease memory consumption, handle the MasterFilterDefaultValues event that occurs before the data is loaded.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the MasterFilterSet event.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.