XRBinding(Parameter, String, String) Constructor

Initializes a new instance of the XRBinding class with the specified parameter, property name and format string.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public XRBinding(
    Parameter parameter,
    string propertyName,
    string formatString
)

VB.NET

Public Sub New(
    parameter As Parameter,
    propertyName As String,
    formatString As String
)

Parameters

Name	Type	Description
parameter	Parameter	A Parameter object specifying the parameter, to which a control’s property should be bound.
propertyName	String	A String value specifying a control’s property name to bind to a parameter. This value is assigned to the XRBinding.PropertyName property.
formatString	String	A String value specifying a format for the output value. This value is assigned to the XRBinding.FormatString property.

Remarks

For more information on using parameters, refer to the Using Report Parameters document.

Example

This example demonstrates how to create a report with a parameter at runtime.

After a parameter is added to the report, its value can be used in the report’s XtraReportBase.FilterString, or displayed in a XRLabel control.

Then, when the report is being previewed, an end-user can modify the parameter’s value via the Parameters UI, which is enabled using the ReportPrintTool.AutoShowParametersPanel property.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Parameters;
// ...

private void simpleButton1_Click(object sender, EventArgs e) {
    // Create a report instance.
    XtraReport1 report = new XtraReport1();

    // Create a parameter and specify its name.
    Parameter param1 = new Parameter();
    param1.Name = "CatID";

    // Specify other parameter properties.
    param1.Type = typeof(System.Int32);
    param1.Value = 1;
    param1.Description = "Category: ";
    param1.Visible = true;

    // Add the parameter to the report.
    report.Parameters.Add(param1);

    // Specify the report's filter string.
    report.FilterString = "[CategoryID] = ?CatID";

    // Force the report creation without previously 
    // requesting the parameter value from end-users.
    report.RequestParameters = false;

    // Show the parameter's value on a Report Header band.
    XRLabel label = new XRLabel();
    label.DataBindings.Add(new XRBinding(param1, "Text", "Category: {0}"));
    ReportHeaderBand reportHeader = new ReportHeaderBand();
    reportHeader.Controls.Add(label);
    report.Bands.Add(reportHeader);

    // Assign the report to a ReportPrintTool,
    // to hide the Parameters panel,
    // and show the report's print preview.
    ReportPrintTool pt = new ReportPrintTool(report);
    pt.AutoShowParametersPanel = true;
    pt.ShowPreviewDialog();
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Parameters
' ...

Private Sub simpleButton1_Click(ByVal sender As Object, _
ByVal e As EventArgs) Handles simpleButton1.Click
    ' Create a report instance.
    Dim report As New XtraReport1()

    ' Create a parameter and specify its name.
    Dim param1 As New Parameter()
    param1.Name = "CatID"

    ' Specify other parameter properties.
    param1.Type = GetType(System.Int32)
    param1.Value = 1
    param1.Description = "Category: "
    param1.Visible = True

    ' Add the parameter to the report.
    report.Parameters.Add(param1)

    ' Specify the report's filter string.
    report.FilterString = "[CategoryID] = ?CatID"

    ' Force the report creation without previously 
    ' requesting the parameter value from end-users.
    report.RequestParameters = False

    ' Show the parameter's value on a Report Header band.
    Dim label As New XRLabel()
    label.DataBindings.Add(New XRBinding(param1, "Text", "Category: {0}"))
    Dim reportHeader As New ReportHeaderBand()
    reportHeader.Controls.Add(label)
    report.Bands.Add(reportHeader)

    ' Assign the report to a ReportPrintTool,
    ' to hide the Parameters panel,
    ' and show the report's print preview.
    Dim pt As New ReportPrintTool(report)
    pt.AutoShowParametersPanel = True
    pt.ShowPreviewDialog()
End Sub