DashboardParameter.LookUpSettings Property

Gets or sets the look-up settings of the dashboard parameter.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(null)]
[LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)]
public ParameterLookUpSettings LookUpSettings { get; set; }

VB.NET

<LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)>
<DefaultValue(Nothing)>
Public Property LookUpSettings As ParameterLookUpSettings

Property Value

Type	Default	Description
ParameterLookUpSettings	null	A ParameterLookUpSettings descendant that specifies the look-up settings of the dashboard parameter.

Remarks

The following look-up settings are available in the WinForms Dashboard:

No Look-Up

Pass null to the DashboardParameter.LookUpSettings property.

Static List

Pass an instance of the StaticListLookUpSettings class to the DashboardParameter.LookUpSettings property. Use the Values property to specify the list of static values for the dashboard parameter.

Dynamic List

Pass an instance of the DynamicListLookUpSettings class to the DashboardParameter.LookUpSettings property. Specify the settings to provide access to data source values.

Examples

Dashboard for WinForms - How to Pass a Dashboard Parameter to a Filter String

Dashboard for WinForms - How to Pass a Dashboard Parameter to a Calculated Field’s Expression

Dashboard for WinForms - How to Pass a Dashboard Parameter to a Custom SQL query

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LookUpSettings 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#

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L14

DashboardParameter priceParameter = new DashboardParameter();
priceParameter.LookUpSettings = null;
priceParameter.Name = "priceParameter";

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

staticListLookUpSettings1.Values = new string[] { "Alabama", "Ohio", "Utah" };
myDashboardParameter.LookUpSettings = staticListLookUpSettings1;
myDashboardParameter.Name = "parameterState";

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

staticListLookUpSettings1.Values = new string[] { "Alabama", "Ohio", "Utah" };
myDashboardParameter.LookUpSettings = staticListLookUpSettings1;
myDashboardParameter.Name = "parameterState";

VB.NET

winforms-dashboard-pass-dashboard-parameters-to-expression-format-condition-in-code/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L18

Dim priceParameter As New DashboardParameter()
priceParameter.LookUpSettings = Nothing
priceParameter.Name = "priceParameter"

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

staticListLookUpSettings1.Values = New String() {"Alabama", "Ohio", "Utah"}
myDashboardParameter.LookUpSettings = staticListLookUpSettings1
myDashboardParameter.Name = "parameterState"

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

staticListLookUpSettings1.Values = New String() { "Alabama", "Ohio", "Utah" }
myDashboardParameter.LookUpSettings = staticListLookUpSettings1
myDashboardParameter.Name = "parameterState"