DashboardViewer.SetMasterFilter(String, Object) Method

Selects required elements by their values in the specified master filter item.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v19.1.Win.dll

Declaration

C#

public void SetMasterFilter(
    string dashboardItemName,
    object values
)

VB.NET

Public Sub SetMasterFilter(
    dashboardItemName As String,
    values As Object
)

Parameters

Name	Type	Description
dashboardItemName	String	A String that specifies the component name of the master filter item.
values	Object	Values that are used to select elements in the master filter item.

Remarks

Note

The method fires the InvalidOperationException if master filtering is disabled in the specified dashboard item (the MasterFilterMode property is set to None). The exception message text is a localizable string which can be obtained by the MessageInteractivityOperationNotAvailable identifier.

Example

This example demonstrates how to apply master filter to a dashboard in code.

The DashboardViewer.SetMasterFilter method selects rows in the Grid dashboard item that acts as master filter. The DashboardViewer.SetRange method selects a time range in the Range Filter dashboard item that acts as master filter.

Note

The complete sample project How to Set Master Filter in DashboardViewer is available in the DevExpress Examples repository.

Form1.cs

using System;
using System.Collections.Generic;
using System.Windows.Forms;
using System.Collections;
using DevExpress.DashboardCommon;

namespace Dashboard_SetMasterFilter {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
            // Loads a dashboard from an XML file.
            dashboardViewer1.LoadDashboard(@"..\..\Data\Dashboard.xml");

            // Creates a list with values to be selected in the Grid dashboard item.
            List<object> rowValues1 = new List<object>();
            rowValues1.AddRange(new[] { "UK", "Anne Dodsworth" } );
            List<object> rowValues2 = new List<object>();
            rowValues2.AddRange(new[] { "USA", "Andrew Fuller" } );
            List<IList> selectedRows = new List<IList>( new[] {rowValues1, rowValues2} );

            // Creates a range with specified minimum and maximum values.
            DateTime minimumValue = new DateTime(1995, 3, 1);
            DateTime maximumValue = new DateTime(1995, 10, 1);
            RangeFilterSelection selectedRange = new RangeFilterSelection(minimumValue, maximumValue);

            // Selects specified values in the Grid dashboard item.
            dashboardViewer1.SetMasterFilter("gridDashboardItem1", selectedRows);
            // Selects a specified range in the Range Filter dashboard item.
            dashboardViewer1.SetRange("rangeFilterDashboardItem1", selectedRange);
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Windows.Forms
Imports System.Collections
Imports DevExpress.DashboardCommon

Namespace Dashboard_SetMasterFilter
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
            ' Loads a dashboard from an XML file.
            dashboardViewer1.LoadDashboard("..\..\Data\Dashboard.xml")

            ' Creates a list with values to be selected in the Grid dashboard item.
            Dim rowValues1 As New List(Of Object)()
            rowValues1.AddRange(New String() { "UK", "Anne Dodsworth" })
            Dim rowValues2 As New List(Of Object)()
            rowValues2.AddRange(New String() { "USA", "Andrew Fuller" })
            Dim selectedRows As New List(Of IList)(New IList() {rowValues1, rowValues2})


            ' Creates a range with specified minimum and maximum values.
            Dim minimumValue As New DateTime(1995, 3, 1)
            Dim maximumValue As New DateTime(1995, 10, 1)
            Dim selectedRange As New RangeFilterSelection(minimumValue, maximumValue)

            ' Selects specified values in the Grid dashboard item.
            dashboardViewer1.SetMasterFilter("gridDashboardItem1", selectedRows)
            ' Selects a specified range in the Range Filter dashboard item.
            dashboardViewer1.SetRange("rangeFilterDashboardItem1", selectedRange)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetMasterFilter(String, Object) method.

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#

how-to-apply-master-filtering-in-code-in-olap-mode-e5098/CS/Dashboard_SetMasterFilter_OLAP/Form1.cs#L24

    // Selects specified cards in the Card dashboard item.
    dashboardViewer1.SetMasterFilter("cardDashboardItem1", selectedCards);
}

how-to-apply-master-filtering-in-dashboardviewer-e5097/CS/Dashboard_SetMasterFilter/Form1.cs#L39

// Select the values in the Grid dashboard item.
dashboardViewer1.SetMasterFilter("gridDashboardItem1", selectedRows);
// Select the range in the Range Filter dashboard item.

how-to-combine-filter-elements-to-a-group-and-bind-them-to-data-t191632/CS/Dashboard_FilterElements_and_Groups/Form1.cs#L16

    dashboardViewer1.Dashboard = CreateDashboard(dataSource);
    dashboardViewer1.SetMasterFilter("comboBoxDashboardItem1", "Internet Explorer");
}

win-viewer-how-to-apply-default-filtering-to-master-filter-items-that-affect-each-other-t474844/CS/MutualDefaultFiltering/Form1.cs#L36

    if (!isNeutralFilterMode)
        dashboardViewer1.SetMasterFilter("cardDashboardItem1", new List<object>() { "UK" });
}

VB.NET

how-to-apply-master-filtering-in-code-in-olap-mode-e5098/VB/Dashboard_SetMasterFilter_OLAP/Form1.vb#L23

    ' Selects specified cards in the Card dashboard item.
    dashboardViewer1.SetMasterFilter("cardDashboardItem1", selectedCards)
End Sub

how-to-apply-master-filtering-in-dashboardviewer-e5097/VB/Dashboard_SetMasterFilter/Form1.vb#L40

' Select the values in the Grid dashboard item.
dashboardViewer1.SetMasterFilter("gridDashboardItem1", selectedRows)
' Select the range in the Range Filter dashboard item.

how-to-combine-filter-elements-to-a-group-and-bind-them-to-data-t191632/VB/Dashboard_FilterElements_and_Groups/Form1.vb#L18

    dashboardViewer1.Dashboard = CreateDashboard(dataSource)
    dashboardViewer1.SetMasterFilter("comboBoxDashboardItem1", "Internet Explorer")
End Sub

win-viewer-how-to-apply-default-filtering-to-master-filter-items-that-affect-each-other-t474844/VB/MutualDefaultFiltering/Form1.vb#L35

If Not isNeutralFilterMode Then
    dashboardViewer1.SetMasterFilter("cardDashboardItem1", New List(Of Object)() From {"UK"})
End If