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.v17.2.Core.dll
Declaration
Property Value
Type | Default | Description |
---|---|---|
String | 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.