Parameter.Name Property

Gets of sets the dashboard parameter name.

Namespace: DevExpress.DataAccess

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DashboardLocalizableCategory(DashboardStringId.CategoryNameGeneral)]
[DefaultValue(null)]
public string Name { get; set; }

VB.NET

<DashboardLocalizableCategory(DashboardStringId.CategoryNameGeneral)>
<DefaultValue(Nothing)>
Public Property Name As String

Property Value

Type	Default	Description
String	null	A String value that specifies the dashboard parameter name.

Remarks

When you create and modify parameter names, follow the rules below:

• A name can contain letters, numbers, and underscores.
• A name cannot contain spaces.
• A name cannot be an empty string.
• The dashboard cannot contain parameters with the same name.
• Names are case-sensitive. For example, you can create the names Parameter and PARAMETER .

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Name 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-designer-merge-dashboards-to-tabs/CS/DashboardMerger/ParametersMerger.cs#L22

DashboardParameterCollection toParameters = dashboardMerger.TargetDashboard.Parameters;
if(toParameters.Any(p => p.Name == parameterCopy.Name)) {
    if(ResolveParameterNamesConflict(parameterCopy, originalParameter.Name, dashboardMerger))

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

priceParameter.LookUpSettings = null;
priceParameter.Name = "priceParameter";
priceParameter.Type = typeof(decimal);

mvc-dashboard-customize-before-displaying-browser/CS/MVCxDashboard/App_Start/DashboardConfig.cs#L26

// customization code
var parameterCountry = d.Parameters.FirstOrDefault(p => p.Name == "CountryDashboardParameter");
if (parameterCountry != null) {

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

myDashboardParameter.LookUpSettings = staticListLookUpSettings1;
myDashboardParameter.Name = "parameterState";
myDashboardParameter.Type = typeof(string);

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

myDashboardParameter.LookUpSettings = staticListLookUpSettings1;
myDashboardParameter.Name = "parameterState";
myDashboardParameter.Type = typeof(string);

VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/ParametersMerger.vb#L26

Dim toParameters As DashboardParameterCollection = dashboardMerger.TargetDashboard.Parameters
If toParameters.Any(Function(p) p.Name = parameterCopy.Name) Then
    If ResolveParameterNamesConflict(parameterCopy, originalParameter.Name, dashboardMerger) Then

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

priceParameter.LookUpSettings = Nothing
priceParameter.Name = "priceParameter"
priceParameter.Type = GetType(Decimal)

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

myDashboardParameter.LookUpSettings = staticListLookUpSettings1
myDashboardParameter.Name = "parameterState"
myDashboardParameter.Type = GetType(String)

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

myDashboardParameter.LookUpSettings = staticListLookUpSettings1
myDashboardParameter.Name = "parameterState"
myDashboardParameter.Type = GetType(String)

web-forms-dashboard-customize-before-displaying-browser/VB/WebApplication7/Default.aspx.vb#L22

' customization code
Dim parameterCountry = dashboard.Parameters.FirstOrDefault(Function(p) Equals(p.Name, "CountryDashboardParameter"))
If parameterCountry IsNot Nothing Then