XRBindingCollection.Add(XRBinding) Method

Appends the specified binding to the current collection.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void Add(
    XRBinding binding
)

VB.NET

Public Sub Add(
    binding As XRBinding
)

Parameters

Name	Type	Description
binding	XRBinding	An XRBinding object to add to the collection.

Example

The following two methods demonstrate how to add and remove an XRBinding object from the control’s collection of data bindings. Data bindings are added in two different ways. For the lbUnitPrice label the binding is first created and then added, for the lbProductName label the binding is created and added simultaneously.

Note that for this example to work correctly, a report must contain the dsProducts dataset, which should use data in the Products table (“SELECT Products.* FROM Products”) from the sample Northwind database.

C#

using DevExpress.XtraReports.UI;
// ...

public class XtraReport1 : DevExpress.XtraReports.UI.XtraReport {
// ...

    public void AddBindings() {
        // Create a data binding.
        XRBinding binding = new XRBinding("Text", dsProducts1, "Products.UnitPrice");

        // Add the created binding to the binding collection of the lbUnitPrice label.
        lbUnitPrice.DataBindings.Add(binding);

        // Create and add the binding to the binding collection of the lbProductName label.
        lbProductName.DataBindings.Add("Text", dsProducts1, "Products.ProductName");
    }

    public void RemoveBinding(XRControl control, string propertyName) {
        // Get the data binding specified by the control's property name.
        XRBinding binding = control.DataBindings[propertyName];

        // Remove the data binding from the control's binding collection.
        if(binding != null)
            control.DataBindings.Remove(binding);
    }

}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Public Class XtraReport1
    Inherits DevExpress.XtraReports.UI.XtraReport
' ...

    Public Sub AddBindings()
        ' Create a data binding.
        Dim binding As New XRBinding("Text", dsProducts1, "Products.UnitPrice")

        ' Add the created binding to the binding collection of the lbUnitPrice label.
        lbUnitPrice.DataBindings.Add(binding)

        ' Create and add the binding to the binding collection of the lbProductName label.
        lbProductName.DataBindings.Add("Text", dsProducts1, "Products.ProductName")
    End Sub

    Public Sub RemoveBinding(ByRef control As XRControl, ByRef propertyName As String)
        ' Get the data binding specified by the control's property name.
        Dim binding = control.DataBindings(propertyName)

        ' Remove the data binding from the control's binding collection.
        If (Not (binding Is Nothing)) Then
            control.DataBindings.Remove(binding)
        End If
    End Sub
End Class

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(XRBinding) method.

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-wpf-create-drill-down-report-document-preview-control/CS/dxWPFApp/MainWindow.xaml.cs#L99

XRTableCell cell = new XRTableCell();
cell.DataBindings.Add(new XRBinding("Text", null, string.Format("{0}.{1}", dataMember, col.Name)));
if (col.Name == "CategoryName") {

reporting-winforms-add-report-parameters/CS/Report_ParametertsPanel/Form1.cs#L39

XRLabel label = new XRLabel();
label.DataBindings.Add(new XRBinding(param1, "Text", "Category: {0}"));
ReportHeaderBand reportHeader = new ReportHeaderBand();

VB.NET

reporting-wpf-create-drill-down-report-document-preview-control/VB/dxWPFApp/MainWindow.xaml.vb#L102

Dim cell As New XRTableCell()
cell.DataBindings.Add(New XRBinding("Text", Nothing, String.Format("{0}.{1}", dataMember, col.Name)))
If col.Name = "CategoryName" Then

reporting-winforms-add-report-parameters/VB/Report_ParametertsPanel/Form1.vb#L36

Dim label As XRLabel = New XRLabel()
label.DataBindings.Add(New XRBinding(param1, "Text", "Category: {0}"))
Dim reportHeader As ReportHeaderBand = New ReportHeaderBand()