Back to Devexpress

Parameter.Description Property

corelibraries-devexpress-dot-xtrareports-dot-parameters-dot-parameter-523ee23b.md

latest7.5 KB
Original Source

Parameter.Description Property

Specifies a parameter description. This description is displayed beside a parameter editor in the Parameters panel.

Namespace : DevExpress.XtraReports.Parameters

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

NuGet Package : DevExpress.Printing.Core

Declaration

csharp
[DefaultValue("")]
[XRLocalizable(true)]
public string Description { get; set; }
vb
<DefaultValue("")>
<XRLocalizable(True)>
Public Property Description As String

Property Value

TypeDefaultDescription
StringString.Empty

A parameter description.

|

Example

To create a parameter in code, initialize a Parameter class instance and specify its properties. Add the parameter to the report’s Parameters collection.

The code sample below demonstrates how to create a date parameter, specify an expression for the parameter’s default value, and reference the parameter in a label‘s expression.

csharp
using System.Drawing;
using DevExpress.XtraReports.UI;
// ...
using DevExpress.XtraReports.Parameters;
// ...
using DevExpress.XtraReports.Expressions;
// ...
// Create a date report parameter.
// Use an expression to specify the parameter's default value.
var dateParameter = new Parameter() {
    Name = "date",
    Description = "Date:",
    Type = typeof(System.DateTime),
    ExpressionBindings = { new BasicExpressionBinding("Value", "Now()") }
};

// Create a label and bind the label's Text property to the parameter value.
// Use the parameter's name to reference the parameter in the label's expression.
var dateLabel = new XRLabel() {
    ExpressionBindings = { new ExpressionBinding("Text", "?date") },
    BoundsF = new RectangleF(0, 0, 200, 50),
};

// Create a report and add the label to the report's Detail band.
var report = new XtraReport() {
    Bands = { new DetailBand() { Controls = { dateLabel } } },
};

// Add the parameter to the report's Parameters collection.
report.Parameters.Add(dateParameter);
vb
Imports DevExpress.XtraReports.UI
' ...
Imports DevExpress.XtraReports.Parameters
' ...
Imports DevExpress.XtraReports.Expressions
' ...
' Create a date report parameter.
' Use an expression to specify the parameter's default value.
Dim dateParameter = New Parameter() With {
    .Name = "date",
    .Description = "Date:",
    .Type = GetType(Date)
}

dateParameter.ExpressionBindings.Add(New BasicExpressionBinding("Value", "Now()"))

' Create a label and bind the label's Text property to the parameter value.
' Use the parameter's name to reference the parameter in the label's expression.
Dim dateLabel = New XRLabel() With {.BoundsF = New RectangleF(0, 0, 200, 50)}

dateLabel.ExpressionBindings.Add(New ExpressionBinding("Text", "?date"))

' Create a report and add the label to the report's Detail band.
Dim report = New XtraReport()
Dim band = New DetailBand()
band.Controls.Add(dateLabel)
report.Bands.Add(band)

' Add the parameter to the report's Parameters collection.
report.Parameters.Add(dateParameter)
'

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.

reporting-winforms-parameter-daterange/CS/Program.cs#L23

csharp
dateRangeParam.Name = "dateRange";
dateRangeParam.Description = "Date Range:";
dateRangeParam.Type = typeof(System.DateTime);

reporting-winforms-parameter-multivalue/CS/Program.cs#L30

csharp
parameter1.MultiValue = true;
parameter1.Description = "Categories: ";

reporting-winforms-add-report-parameters/CS/ReportParameterExample/Form1.cs#L22

csharp
param1.Value = 1;
param1.Description = "Category: ";
param1.Visible = true;

reporting-winforms-parameter-dynamic-list/CS/Form1.cs#L29

csharp
param.Name = "employeePosition";
param.Description = "Employee position:";
param.Type = typeof(string);

reporting-winforms-parameter-daterange/VB/Program.vb#L20

vb
dateRangeParam.Name = "dateRange"
dateRangeParam.Description = "Date Range:"
dateRangeParam.Type = GetType(Date)

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

vb
dateParameter.Name = "dateParameter"
dateParameter.Description = "Date:"
dateParameter.Type = GetType(Date)

reporting-winforms-add-report-parameters/VB/ReportParameterExample/Form1.vb#L23

vb
param1.Value = 1
param1.Description = "Category: "
param1.Visible = True

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

vb
param.Name = "employeePosition"
param.Description = "Employee position:"
param.Type = GetType(String)

See Also

RequestParameters

Use Report Parameters

Parameter Class

Parameter Members

DevExpress.XtraReports.Parameters Namespace