DashboardItemInteractivityOptions.MasterFilterMode Property

Gets or sets the selection mode of the master filter item.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.2.Core.dll

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

[DefaultValue(DashboardItemMasterFilterMode.None)]
public virtual DashboardItemMasterFilterMode MasterFilterMode { get; set; }

VB.NET

<DefaultValue(DashboardItemMasterFilterMode.None)>
Public Overridable Property MasterFilterMode As DashboardItemMasterFilterMode

Property Value

Type	Default	Description
DashboardItemMasterFilterMode	None	A DashboardItemMasterFilterMode enumeration value that specifies the selection mode of the master filter item.

Available values:

Name	Description
None	Master filtering is disabled.
Single	Allows a user to select a single element within the dashboard item. The selection cannot be empty.
Multiple	Allows a user to switch between the single or multiple selection within the dashboard item. The selection can be empty.

Property Paths

You can access this nested property as listed below:

Object Type	Path to MasterFilterMode
CustomDashboardItem	.InteractivityOptions .MasterFilterMode
GridDashboardItem	.InteractivityOptions .MasterFilterMode
KpiDashboardItem<TKpiElement>	.InteractivityOptions .MasterFilterMode
MapDashboardItem	.InteractivityOptions .MasterFilterMode
ScatterChartDashboardItem	.InteractivityOptions .MasterFilterMode

Remarks

If the selection mode is Single and you pass multiple master filter values in the dashboard state, the first value from the state will be used as a master filter value.

To learn more about master filtering, see the Master Filtering topic.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MasterFilterMode property.

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.

C#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.cs#L124

void SetSelectionMode() {
    switch(dashboardItem.InteractivityOptions.MasterFilterMode) {
        case DashboardItemMasterFilterMode.None:

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/TreeList/TreeListItemControlProvider.vb#L133

Private Sub SetSelectionMode()
    Select Case dashboardItem.InteractivityOptions.MasterFilterMode
        Case DashboardItemMasterFilterMode.None