Back to Devexpress

DashboardViewer.GetCurrentFilterValues(String) Method

dashboard-devexpress-dot-dashboardwin-dot-dashboardviewer-dot-getcurrentfiltervalues-x28-system-dot-string-x29.md

latest3.6 KB
Original Source

DashboardViewer.GetCurrentFilterValues(String) Method

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

Namespace : DevExpress.DashboardWin

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

NuGet Package : DevExpress.Win.Dashboard

Declaration

csharp
public IList<AxisPointTuple> GetCurrentFilterValues(
    string dashboardItemName
)
vb
Public Function GetCurrentFilterValues(
    dashboardItemName As String
) As IList(Of AxisPointTuple)

Parameters

NameTypeDescription
dashboardItemNameString

A String that is the component name of the master filter item.

|

Returns

TypeDescription
IList<AxisPointTuple>

A list of AxisPointTuple objects identifying elements that can be selected in the current state of the master filter item.

|

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.

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

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

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

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

Implements

GetCurrentFilterValues(String)

See Also

GetCurrentDrillDownValues(String)

DashboardViewer Class

DashboardViewer Members

DevExpress.DashboardWin Namespace