DynamicListLookUpSettings Class

Provides the look-up editor settings for dashboard parameters that are bound to a data source.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

C#

public class DynamicListLookUpSettings :
    ParameterLookUpSettings

VB.NET

Public Class DynamicListLookUpSettings
    Inherits ParameterLookUpSettings

Remarks

Use the DashboardParameter.LookUpSettings property to specify the look-up editor settings of the parameter.

Example

The following example demonstrates how to create a new dashboard parameter and pass it to a dashboard item filter string.

In this example, the dashboard data source contains two queries - the SalesPerson query is used for data visualization while the Categories query provides values for the dashboard parameter.

After the dashboard parameter is created, it is passed to a dashboard item’s filter strings. So, the dashboard displays data according to the selected values.

View Example

Form1.cs

using DevExpress.XtraEditors;
using DevExpress.DashboardCommon;

namespace Dashboard_Parameters {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            Dashboard dashboard = new Dashboard();
            dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");

            // Obtain dashboard items and specify identifiers for data items.
            GridDashboardItem grid = (GridDashboardItem)dashboard.Items[0];
            PieDashboardItem pie = (PieDashboardItem)dashboard.Items[1];  
            ((GridDimensionColumn)grid.Columns[0]).Dimension.UniqueId = "categoryColumn";
            pie.SeriesDimensions[0].UniqueId = "categorySeries";

            // Obtain the dashboard data source used to provide parameter values.
            DashboardSqlDataSource parameterDataSource = 
                (DashboardSqlDataSource)dashboard.DataSources[0];

            // Create a new parameter that obtains its values from the Categories query.
            DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
            settings.DataSource = parameterDataSource;
            settings.DataMember = "Categories";
            settings.ValueMember = "CategoryName";
            DashboardParameter parameter = new DashboardParameter("categoryParameter", 
                typeof(string), "Beverages", "Select categories:", true, settings);
            // Enable multi-selection for the created parameter.
            parameter.AllowMultiselect = true;

            // Add the created parameter to a collection of dashboard parameters.
            dashboard.Parameters.Add(parameter);

            // Include the created parameter in filter strings as an operand value.
            grid.FilterString = "categoryColumn in (?categoryParameter)";
            pie.FilterString = "categorySeries in (?categoryParameter)";

            dashboardViewer1.Dashboard = dashboard;
        }
    }
}

Form1.vb

Imports DevExpress.XtraEditors
Imports DevExpress.DashboardCommon

Namespace Dashboard_Parameters
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("..\..\Data\Dashboard.xml")

            ' Obtain dashboard items and specify identifiers for data items.
            Dim grid As GridDashboardItem = CType(dashboard.Items(0), GridDashboardItem)
            Dim pie As PieDashboardItem = CType(dashboard.Items(1), PieDashboardItem)
            CType(grid.Columns(0), GridDimensionColumn).Dimension.UniqueId = "categoryColumn"
            pie.SeriesDimensions(0).UniqueId = "categorySeries"

            ' Obtain the dashboard data source used to provide parameter values.
            Dim parameterDataSource As DashboardSqlDataSource = DirectCast(dashboard.DataSources(0), DashboardSqlDataSource)

            ' Create a new parameter that obtains its values from the Categories query.
            Dim settings As New DynamicListLookUpSettings()
            settings.DataSource = parameterDataSource
            settings.DataMember = "Categories"
            settings.ValueMember = "CategoryName"
            Dim parameter As New DashboardParameter("categoryParameter", GetType(String), "Beverages", "Select categories:", True, settings)
            ' Enable multi-selection for the created parameter.
            parameter.AllowMultiselect = True

            ' Add the created parameter to a collection of dashboard parameters.
            dashboard.Parameters.Add(parameter)

            ' Include the created parameter in filter strings as an operand value.
            grid.FilterString = "categoryColumn in (?categoryParameter)"
            pie.FilterString = "categorySeries in (?categoryParameter)"

            dashboardViewer1.Dashboard = dashboard
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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#

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/CS/Dashboard_OlapFiltering/Form1.cs#L22

DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
settings.DataSource = olapDataSource;

aspxdashboard-how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-t481105/CS/ASPxDashboard_OlapFiltering/WebForm1.aspx.cs#L24

DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
settings.DataSource = olapDataSource;

web-dashboard-apply-item-filtering-olap-mode/CS/ASPxDashboard_OlapFiltering/WebForm1.aspx.cs#L23

DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
settings.DataSource = olapDataSource;

how-to-pass-a-dashboard-parameter-to-a-filter-string-in-code-e5117/CS/Dashboard_Parameters/Form1.cs#L22

// Create a new parameter that obtains its values from the Categories query.
DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
settings.DataSource = parameterDataSource;

how-to-replace-dashboardsqldatasource-with-dashboardobjectdatasource-with-filtered-data-t556759/CS/ASPxDashboard/Default.aspx.cs#L85

}
foreach (var parameter in dashboard.Parameters.Select(p => p.LookUpSettings).OfType<DynamicListLookUpSettings>().Where(p => Object.ReferenceEquals( p.DataSource, query.DataSource) && p.DataMember == query.Query.Name)) {
    parameter.DataMember = "";

VB.NET

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/VB/Dashboard_OlapFiltering/Form1.vb#L24

Dim settings As New DynamicListLookUpSettings()
settings.DataSource = olapDataSource

aspxdashboard-how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-t481105/VB/ASPxDashboard_OlapFiltering/WebForm1.aspx.vb#L25

Dim settings As New DynamicListLookUpSettings()
settings.DataSource = olapDataSource

web-dashboard-apply-item-filtering-olap-mode/VB/ASPxDashboard_OlapFiltering/WebForm1.aspx.vb#L25

Dim settings As New DynamicListLookUpSettings()
settings.DataSource = olapDataSource

how-to-pass-a-dashboard-parameter-to-a-filter-string-in-code-e5117/VB/Dashboard_Parameters/Form1.vb#L23

' Create a new parameter that obtains its values from the Categories query.
Dim settings As New DynamicListLookUpSettings()
settings.DataSource = parameterDataSource

how-to-replace-dashboardsqldatasource-with-dashboardobjectdatasource-with-filtered-data-t556759/VB/ASPxDashboard/Default.aspx.vb#L87

Next item
For Each parameter In dashboard.Parameters.Select(Function(p) p.LookUpSettings).OfType(Of DynamicListLookUpSettings)().Where(Function(p) Object.ReferenceEquals(p.DataSource, dsQuery.DataSource) AndAlso p.DataMember = dsQuery.Query.Name)
    parameter.DataMember = ""

Inheritance

Object

ParameterLookUpSettings

DynamicListLookUpSettings