DashboardParameter.Description Property

Gets or sets the dashboard parameter’s description displayed for users.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

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

VB.NET

<LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)>
<DefaultValue(Nothing)>
Public Property Description As String

Property Value

Type	Default	Description
String	null	A String that specifies the dashboard parameter’s description displayed to an user.

Remarks

Specifies the parameter description displayed in the Parameter column of the Dashboard Parameters dialog.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Description 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#L18

priceParameter.Value = 150000;
priceParameter.Description = "Format values that are greater than";
dashboard.Parameters.Add(priceParameter);

VB.NET

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

priceParameter.Value = 150000
priceParameter.Description = "Format values that are greater than"
dashboard.Parameters.Add(priceParameter)