ASPxDashboardViewer.MasterFilterDefaultValues Event

Allows you to apply default filtering to master filter items.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll

Declaration

public event MasterFilterDefaultValuesWebEventHandler MasterFilterDefaultValues
Public Event MasterFilterDefaultValues As MasterFilterDefaultValuesWebEventHandler

The MasterFilterDefaultValues event handler receives an argument of the MasterFilterDefaultValuesWebEventArgs type. The following properties provide information specific to this event.

Property Description
AvailableFilterValues Gets the list of values that can be used to apply filtering.
DashboardId Gets the dashboard identifier.
FilterValues Gets or sets values used to apply default filtering.
ItemComponentName Gets the component name of the dashboard item.
ItemName Gets the dashboard item name.

The MasterFilterDefaultValues event is raised for all master filter items (except RangeFilterDashboardItem) before loading a dashboard to ASPxDashboardViewer and allows you to apply default filtering to master filter items. Perform the following steps to do this.

  1. Check the name of the dashboard item for which the event was raised using the MasterFilterDefaultValuesWebEventArgs.ItemName/MasterFilterDefaultValuesWebEventArgs.ItemComponentName properties.
  2. Obtain values available for filtering using MasterFilterDefaultValuesWebEventArgs.AvailableFilterValues.
  3. Apply default filtering using the MasterFilterDefaultValuesWebEventArgs.FilterValues property or by calling the MasterFilterDefaultValuesWebEventArgs.SetFilterValues method.
Note

Note that the MasterFilterDefaultValues event has limitations when applying default filtering to master filter items that affect each other. To learn more, see the following example: How to apply default filtering to master filter items that affect each other.

See Also