DashboardViewer.SetMasterFilter(String, IEnumerable<DashboardDataRow>) Method

Selects required elements in the specified master filter item.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v18.2.Win.dll

Declaration

C#

public void SetMasterFilter(
    string dashboardItemName,
    IEnumerable<DashboardDataRow> values
)

VB.NET

Public Sub SetMasterFilter(
    dashboardItemName As String,
    values As IEnumerable(Of DashboardDataRow)
)

Parameters

Name	Type	Description
dashboardItemName	String	A String that specifies the component name of the master filter item.
values	IEnumerable<DashboardDataRow>	A list of DashboardDataRow objects used to identify master filter elements.

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetMasterFilter(String, IEnumerable<DashboardDataRow>) 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#

winforms-dashboard-linked-interactivity/CS/WinDashboard_LinkedInteractivity/Form2.cs#L31

if (e.SelectedValues != null)
    this.dashboardViewer1.SetMasterFilter(itemName, e.SelectedValues);
if (e.SelectedRange != null)

VB.NET

winforms-dashboard-linked-interactivity/VB/WinDashboard_LinkedInteractivity/Form2.vb#L33

If e.SelectedValues IsNot Nothing Then
    Me.dashboardViewer1.SetMasterFilter(itemName, e.SelectedValues)
End If