DashboardViewer.GetCurrentFilterValues(String) Method

Returns axis point tuples identifying currently selected elements in the master filter item.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public IList<AxisPointTuple> GetCurrentFilterValues(
    string dashboardItemName
)

VB.NET

Public Function GetCurrentFilterValues(
    dashboardItemName As String
) As IList(Of AxisPointTuple)

Parameters

Name	Type	Description
dashboardItemName	String	A String that is the component name of the master filter item.

Returns

Type	Description
IList<AxisPointTuple>	A list of AxisPointTuple objects identifying elements that can be selected in the current state of the master filter item.

Related GitHub Examples

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

C#

winforms-dashboard-customize-title-and-item-captions/CS/CustomizeDashboardItemCaptionExample/ViewerForm1.cs#L33

if (viewer.CanSetMasterFilter(item.ComponentName)) {
    var filterValues = viewer.GetCurrentFilterValues(item.ComponentName);
    filterText += GetFilterText(filterValues);

VB.NET

winforms-dashboard-customize-title-and-item-captions/VB/CustomizeDashboardItemCaptionExample/ViewerForm1.vb#L36

If viewer.CanSetMasterFilter(item.ComponentName) Then
    Dim filterValues = viewer.GetCurrentFilterValues(item.ComponentName)
    filterText &= GetFilterText(filterValues)

Implements

GetCurrentFilterValues(String)