Back to Devexpress

DashboardControl.CanClearMasterFilter(String) Method

dashboard-devexpress-dot-dashboardwpf-dot-dashboardcontrol-dot-canclearmasterfilter-x28-system-dot-string-x29.md

latest3.5 KB
Original Source

DashboardControl.CanClearMasterFilter(String) Method

Returns whether the specified master filter can be cleared in the current state.

Namespace : DevExpress.DashboardWpf

Assembly : DevExpress.Dashboard.v25.2.Wpf.dll

NuGet Package : DevExpress.Wpf.Dashboard

Declaration

csharp
public bool CanClearMasterFilter(
    string dashboardItemName
)
vb
Public Function CanClearMasterFilter(
    dashboardItemName As String
) As Boolean

Parameters

NameTypeDescription
dashboardItemNameString

A String that specifies the component name of the dashboard item.

|

Returns

TypeDescription
Boolean

true , if the specified master filter can be cleared in the current state; otherwise, false.

|

Remarks

To clear the specified master filter item, use the DashboardControl.ClearMasterFilter method.

The example demonstrates how to synchronize Master Filter and Drill-Down actions between different dashboards:

View Example

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CanClearMasterFilter(String) 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.

wpf-dashboard-linked-interactivity/CS/WpfDashboard_LinkedInteractivity/ChildWindow.xaml.cs#L54

csharp
string itemName = e.DashboardItemName;
if (childDashboardControl.CanClearMasterFilter(itemName))
    childDashboardControl.ClearMasterFilter(itemName);

wpf-dashboard-linked-interactivity/VB/WpfDashboard_LinkedInteractivity/ChildWindow.xaml.vb#L48

vb
Dim itemName As String = e.DashboardItemName
If childDashboardControl.CanClearMasterFilter(itemName) Then
    childDashboardControl.ClearMasterFilter(itemName)

See Also

DashboardControl Class

DashboardControl Members

DevExpress.DashboardWpf Namespace