DynamicListLookUpSettings.ValueMember Property
Gets or sets the data member for the dashboard parameter’s value.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.1.Core.dll
NuGet Package: DevExpress.Dashboard.Core
Declaration
[DataFieldsBrowser(DataFieldsBrowserDisplayMode.Dimensions)]
[DefaultValue(null)]
[LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)]
public string ValueMember { get; set; }
Property Value
Type | Default | Description |
---|---|---|
String | null | A String that specifies the data member for the dashboard parameter’s value. |
Remarks
Use the DynamicListLookUpSettings.DataSource property to specify the data source for the dashboard parameter.
You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:
UI Settings | Description | API |
---|---|---|
Data Source | Specifies the data source for the dashboard parameter. | DataSource |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | DataMember |
Value Member | Specifies the name of the data field for the parameter values. | ValueMember |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | DisplayMember |
Sort By (optional) | Specifies the data member used to sort parameter values. | SortByMember |
Sort Order (optional) | Specifies the sort order. | SortOrder |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
The following code snippet shows how to create a dashboard parameter with dynamic look-up values in code. Use the Dashboard.Parameters property of Dashboard to access a collection of dashboard parameters.
DynamicListLookUpSettings settings = new DynamicListLookUpSettings();
settings.DataSource = sqlDataSource;
settings.DataMember = "Categories";
settings.ValueMember = "CategoryID";
settings.DisplayMember = "CategoryName";
settings.SortOrder = DimensionSortOrder.Descending;
DashboardParameter parameter3 = new DashboardParameter("Parameter3", typeof(string), "1", "Select a category:", true, settings);
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the ValueMember 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.