IDashboardDataSource.Filter Property

Gets or sets the logical expression to be applied to the data for filtering.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[Browsable(false)]
string Filter { get; set; }

VB.NET

<Browsable(False)>
Property Filter As String

Property Value

Type	Description
String	A String value specifying the logical expression to be applied to the data for filtering.

Remarks

To learn more about building filter criteria, see Expression Constants, Operators, and Functions.

Tip

You can use the Filter Editor to compose a filter string.

After specifying a filter criteria, call the viewer’s or designer’s ReloadData method to obtain data which meets the criteria.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Filter property.

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#

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/CS/WPF_Dashboard_CustomParameters/ViewModels/MyViewModel.cs#L17

dashboard.Parameters.Add(CreateParameter());
dashboard.DataSources[0].Filter = "[State] In (?parameterState)";
Dashboard = dashboard;

winforms-dashboard-how-to-manage-dashboard-parameters-in-code/CS/CustomParametersExample/ViewerForm1.cs#L13

dashboardViewer.Dashboard.Parameters.Add(CreateParameter());
dashboardViewer.Dashboard.DataSources[0].Filter = "[State] In (?parameterState)";
dashboardViewer.ReloadData();

VB.NET

wpf-dashboard-how-to-manage-dashboard-parameters-in-code/VB/WPF_Dashboard_CustomParameters/ViewModels/MyViewModel.vb#L17

dashboard_Renamed.Parameters.Add(CreateParameter())
dashboard_Renamed.DataSources(0).Filter = "[State] In (?parameterState)"
Dashboard = dashboard_Renamed

winforms-dashboard-how-to-manage-dashboard-parameters-in-code/VB/CustomParametersExample/ViewerForm1.vb#L16

dashboardViewer.Dashboard.Parameters.Add(CreateParameter())
dashboardViewer.Dashboard.DataSources(0).Filter = "[State] In (?parameterState)"
dashboardViewer.ReloadData()