Parameter.Description Property

Specifies a description displayed to an end-user, along with the parameter’s editor in the Parameters UI, that is generated if the XtraReport.RequestParameters property is enabled.

Namespace: DevExpress.XtraReports.Parameters

Assembly: DevExpress.Printing.v18.2.Core.dll

Declaration

C#

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

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Property Description As String

Property Value

Type	Default	Description
String	String.Empty	A String containing the parameter’s description.

Remarks

When the XtraReport.RequestParameters property is enabled, use the Description property to specify a text description which accompanies the Parameters UI.

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

And, if the Print Preview Form isn’t shown (e.g. when a report is sent directly to a printer or exported to a file - more precisely, every time the XtraReport.CreateDocument method is called), the description appears in the following auto-generated dialog.

For more information, refer to 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.