XRBindingCollection Class

Provides methods and properties for creating a collection of XRBinding objects.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public class XRBindingCollection :
    CollectionBase,
    ICloneable,
    IDisposable,
    IEnumerable<XRBinding>,
    IEnumerable

VB.NET

Public Class XRBindingCollection
    Inherits CollectionBase
    Implements ICloneable,
               IDisposable,
               IEnumerable(Of XRBinding),
               IEnumerable

Related API Members

The following members return XRBindingCollection objects:

• SubreportBase.DataBindings
• XRControl.DataBindings
• XRLine.DataBindings

Remarks

Methods of the XRBindingCollection class allow you to create XRBinding objects, XRBindingCollection.Add them to and XRBindingCollection.Remove them from 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

Inheritance

Object

CollectionBase

XRBindingCollection