XRBindingCollection.Add(String, Object, String) Method

Creates an XRBinding object and adds it to the collection.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public XRBinding Add(
    string propertyName,
    object dataSource,
    string dataMember
)

VB.NET

Public Function Add(
    propertyName As String,
    dataSource As Object,
    dataMember As String
) As XRBinding

Parameters

Name	Type	Description
propertyName	String	The name of the control’s property to bind.
dataSource	Object	An object that represents the data source.
dataMember	String	A string containing a navigation path resolving to the property of an object.

Returns

Type	Description
XRBinding	An XRBinding object.

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 demo Northwind database (nwind.mdb file located in the directory, where you installed DevExpress demos).

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(String, Object, String) 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_how-to-create-a-custom-composite-control-e4583/CS/docCustomControls/MyCompositeControl.cs#L35

XRLabel label1 = new XRLabel();
label1.DataBindings.Add("Text", null, "CategoryID");
label1.SizeF = new System.Drawing.SizeF(50, 25);

Reporting_can-xtrareport-be-used-in-unbound-mode-e571/CS/XtraReport1.cs#L46

// data bound report elements
xrLabel1.DataBindings.Add("Text", DataSource, "Name");
xrLabel2.DataBindings.Add("Text", DataSource, "Phone");

Reporting_how-to-create-a-report-based-on-hierarchical-data-e1741/CS/Form1.cs#L75

    if(addKeyFields || (!addKeyFields && !dataColumn.ColumnName.ToUpper().Contains("ID")))
        table.Rows[0].Cells[cellIndex++].DataBindings.Add("Text", null, dataPath + "." + dataColumn.ColumnName);
}

Reporting_how-to-check-which-control-initiates-creating-extra-empty-pages-after-every-page-in-e2338/CS/Form1.cs#L37

XRLabel l = new XRLabel();
l.DataBindings.Add("Text", null, "FullName");
l.Location = new Point(0, 0);

reporting-winforms-change-formatting-xrrichtext-rtf-content/CS/XtraReport1.cs#L21

    else
        xrRichText1.DataBindings.Add("Rtf", null, "Cars.RtfContent");
}

VB.NET

Reporting_how-to-create-a-custom-composite-control-e4583/VB/docCustomControls/MyCompositeControl.vb#L35

Dim label1 As New XRLabel()
label1.DataBindings.Add("Text", Nothing, "CategoryID")
label1.SizeF = New System.Drawing.SizeF(50, 25)

Reporting_can-xtrareport-be-used-in-unbound-mode-e571/VB/XtraReport1.vb#L45

' data bound report elements
xrLabel1.DataBindings.Add("Text", DataSource, "Name")
xrLabel2.DataBindings.Add("Text", DataSource, "Phone")

reporting-winforms-filter-report-data-query/VB/QueryParametersRuntime/XtraReport1.vb#L39

If Settings.Default.UserDesignerOptions.DataBindingMode = DataBindingMode.Bindings Then
    xrLabel1.DataBindings.Add("Text", ds, "Products.CategoryID")
    xrLabel2.DataBindings.Add("Text", ds, "Products.ProductName")

Reporting_how-to-create-a-report-based-on-hierarchical-data-e1741/VB/Form1.vb#L68

    Dim dataColumn As DataColumn = dataTable.Columns(i)
    If addKeyFields OrElse (Not addKeyFields AndAlso Not dataColumn.ColumnName.ToUpper().Contains("ID")) Then table.Rows(0).Cells(Math.Min(Threading.Interlocked.Increment(cellIndex), cellIndex - 1)).DataBindings.Add("Text", Nothing, dataPath & "." & dataColumn.ColumnName)
Next

Reporting_how-to-check-which-control-initiates-creating-extra-empty-pages-after-every-page-in-e2338/VB/Form1.vb#L42

Dim l As New XRLabel()
l.DataBindings.Add("Text", Nothing, "FullName")
l.Location = New Point(0, 0)