Parameter.Value Property

Specifies the report parameter‘s value.

Namespace: DevExpress.XtraReports.Parameters

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

Declaration

C#

public object Value { get; set; }

VB.NET

Public Property Value As Object

Property Value

Type	Description
Object	The parameter’s value.

Remarks

Use this property to specify a parameter’s value.

As an alternative, you can add an item to the ExpressionBindings property to set an expression that specifies the parameter’s Value.

Specify the parameter’s Type to define the data type the parameter stores and which editor the parameter uses in Print Preview.

Example

The code sample below illustrates how to create a date parameter and filter report data by this parameter.

C#

using DevExpress.XtraReports.Parameters;
using DevExpress.XtraReports.Expressions;
// ...
XtraReport1 report = new XtraReport1();
Parameter myDateParameter = new Parameter();
myDateParameter.Name = "myDateParameter";
// Set the Visible property to true to request the parameter value from users.
// Set this property to false to assign the parameter's value in code.
myDateParameter.Visible = false;
myDateParameter.Type = typeof(System.DateTime);
myDateParameter.Value = new DateTime(2019, 1, 1);
report.Parameters.Add(myDateParameter);
// Filter report data by the specified parameter.
report.FilterString = "GetDate([OrderDate]) >= ?myDateParameter";

VB.NET

Imports DevExpress.XtraReports.Parameters
Imports DevExpress.XtraReports.Expressions
' ...
Private report As New XtraReport1()
Private myDateParameter As New Parameter()
myDateParameter.Name = "myDateParameter"
' Set the Visible property to true to request the parameter value from users.
' Set this property to false to assign the parameter's value in code.
myDateParameter.Visible = False
myDateParameter.Type = GetType(Date)
myDateParameter.Value = New Date(2019, 1, 1)
report.Parameters.Add(myDateParameter)
' Filter report data by the specified parameter.
report.FilterString = "GetDate([OrderDate]) >= ?myDateParameter"

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value 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_getting-started-xtrareports-e5144/CS/SalaryReports - Step 05/Reports/EmployeeReport.cs#L19

EmployeeReport report = sender as EmployeeReport;
int year = Convert.ToInt32(report.Parameters["paramYear"].Value);
int month = Convert.ToInt32(report.Parameters["paramMonth"].Value);

Reporting_how-to-create-a-drill-through-report-that-supports-backward-navigation-to-a-t455654/CS/ExtendedDrillThroughReport/CategoriesReport.cs#L34

ProductsReport productReport = new ProductsReport(this, Viewer);
productReport.Parameters["CategoryID"].Value = (int)((DataRowView)e.Brick.Value).Row["CategoryID"];
productReport.Parameters["CategoryName"].Value = ((DataRowView)e.Brick.Value).Row["CategoryName"].ToString();

Reporting_how-to-cancel-parameter-submitting-if-user-input-validation-fails-e2045/CS/CancelSubmitParameters/XtraReport1.cs#L18

ParametersRequestEventArgs e) {
if ((int)e.ParametersInformation[0].Parameter.Value > 10 ||
    (int)e.ParametersInformation[0].Parameter.Value < 0) {

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

    new string[] { "(Custom)", "Month", "3 Months", "6 Months", "Year", "2 Years", "5 Years", "10 Years" });
TimePeriod timePeriod = (TimePeriod)info.Parameter.Value;
if(timePeriod != TimePeriod.Custom) {

Reporting_how-to-create-a-hierarchical-report-t456484/CS/TreeViewReport/ChildReport.cs#L17

ChildReport childReport = new ChildReport();
childReport.Parameters["Level"].Value = this.Parameters["Level"].Value;
childReport.DataSource = parentNode.Children;

VB.NET

Reporting_getting-started-xtrareports-e5144/VB/SalaryReports - Step 10/Reports/EmployeeReport.vb#L17

Dim report As EmployeeReport = TryCast(sender, EmployeeReport)
Dim year As Integer = Convert.ToInt32(report.Parameters("paramYear").Value)
Dim month As Integer = Convert.ToInt32(report.Parameters("paramMonth").Value)

Reporting_how-to-create-a-drill-through-report-that-supports-backward-navigation-to-a-t455654/VB/ExtendedDrillThroughReport/CategoriesReport.vb#L36

Dim productReport As New ProductsReport(Me, Viewer)
productReport.Parameters("CategoryID").Value = DirectCast(DirectCast(e.Brick.Value, DataRowView).Row("CategoryID"), Integer)
productReport.Parameters("CategoryName").Value = DirectCast(e.Brick.Value, DataRowView).Row("CategoryName").ToString()

Reporting_how-to-cancel-parameter-submitting-if-user-input-validation-fails-e2045/VB/CancelSubmitParameters/XtraReport1.vb#L20

ByVal e As ParametersRequestEventArgs) Handles MyBase.ParametersRequestSubmit
If CInt(Fix(e.ParametersInformation(0).Parameter.Value)) > 10 _
    OrElse CInt(Fix(e.ParametersInformation(0).Parameter.Value)) < 0 Then

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

info.Editor = CreatePeriodEditor(System.Enum.GetValues(GetType(TimePeriod)), New String() { "(Custom)", "Month", "3 Months", "6 Months", "Year", "2 Years", "5 Years", "10 Years" })
Dim timePeriod As TimePeriod = CType(info.Parameter.Value, TimePeriod)
If timePeriod <> TimePeriod.Custom Then

Reporting_how-to-create-a-hierarchical-report-t456484/VB/TreeViewReport/ChildReport.vb#L19

Dim childReport As New ChildReport()
childReport.Parameters("Level").Value = Me.Parameters("Level").Value
childReport.DataSource = parentNode.Children

Implements

Value