Parameter.Description Property

Specifies a description that identifies a parameter editor in the Parameters UI.

Namespace: DevExpress.XtraReports.Parameters

Assembly: DevExpress.Printing.v21.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[DefaultValue("")]
[XRLocalizable(true)]
public string Description { get; set; }

VB.NET

<DefaultValue("")>
<XRLocalizable(True)>
Public Property Description As String

Property Value

Type	Default	Description
String	String.Empty	A String that is the parameter description.

Remarks

Use the Description property to specify a text description for the Parameters UI.

The following code creates and adds a parameter with the Company description:

XtraReport1 report = new XtraReport1();
DevExpress.XtraReports.Parameters.Parameter parameter1 = new DevExpress.XtraReports.Parameters.Parameter();
parameter1.Description = "Company";
parameter1.ExpressionBindings.AddRange(new DevExpress.XtraReports.Expressions.BasicExpressionBinding[]
{
    new DevExpress.XtraReports.Expressions.BasicExpressionBinding("Value", "AFKI")
});
parameter1.Name = "parameter1";
report.Parameters.Add(parameter1);

In the Print Preview, the description appears in the Parameters panel.

If you assign a report to the ReportPrintTool and subsequently call the XtraReport.CreateDocument method, and the XtraReport.RequestParameters property is enabled, the dialog appears that prompts for the report parameter values. The Description value identifies a parameter editor:

For more information, review the following help topic: Using Report Parameters.

Related GitHub Examples

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

Reporting_how-to-assign-a-list-of-dynamic-values-to-a-report-parameter-e4081/CS/DynamicParameterValues/XtraReport1.cs#L19

parameter1.Visible = true;
parameter1.Description = "Product Name: ";

Reporting_how-to-assign-a-list-of-static-values-to-a-report-parameter-e4082/CS/StaticParameterValues/XtraReport1.cs#L22

parameter1.Visible = true;
parameter1.Description = "Product Name: ";

Reporting_how-to-create-parameter-editors-that-are-dependent-on-each-others-values-e3291/CS/DependentEditors/XtraReportBase.cs#L189

parameter.Type = type;
parameter.Description = description;
parameter.Value = value;

VB.NET

Reporting_how-to-create-parameter-editors-that-are-dependent-on-each-others-values-e3291/VB/DependentEditors/XtraReportBase.vb#L203

parameter.Type = type
parameter.Description = description
parameter.Value = value

reporting-winforms-parameter-dynamic-list/VB/MultiValueParametersExample/Form1.vb#L25

param1.MultiValue = True
param1.Description = "Categories: "
Dim lookupSettings As DynamicListLookUpSettings = New DynamicListLookUpSettings()

reporting-winforms-parameter-static-list/VB/ParameterLookUpWindowsFormsApplication/Form1.vb#L26

parameter1.Visible = True
parameter1.Description = "Category Name: "
' Populate the parameter's lookup editor with a set of values.