XRControl.DataBindings Property

Provides access to the collection of a control’s bindings.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[SRCategory(ReportStringId.CatData)]
public virtual XRBindingCollection DataBindings { get; }

VB.NET

<SRCategory(ReportStringId.CatData)>
Public Overridable ReadOnly Property DataBindings As XRBindingCollection

Property Value

Type	Description
XRBindingCollection	An XRBindingCollection value, specifying the collection of the control’s bindings.

Remarks

Note

This property is in effect when a UserDesignerOptions.DataBindingMode is set to DataBindingMode.Bindings.

To bind a control’s property to the property of a data source, add an XRBinding object to the control’s collection.

At design time, a control’s data binding is allowed to be incorrect, assuming that a data source may be provided at runtime. However, if the data binding still remains incorrect at the time a report document is being generated, the data binding is assumed to be not set, and a control is treated as unbound.

To learn more on using the DataBindings property, refer to Binding Report Controls to Data.

Not all descendants of the XRControl class use the DataBindings property. For example, the Band class descendants ignore the DataBindings property.

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