Worksheet.DataBindings Property

Provides access to the collection of WorksheetDataBinding objects.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v17.2.Core.dll

Declaration

C#

WorksheetDataBindingCollection DataBindings { get; }

VB.NET

ReadOnly Property DataBindings As WorksheetDataBindingCollection

Property Value

Type	Description
WorksheetDataBindingCollection	A WorksheetDataBindingCollection object that is the collection of all data bindings specified in a worksheet.

Remarks

Use the DataBindings property to get access to the WorksheetDataBindingCollection collection, which stores all data bindings specified in a worksheet. To bind a cell range in a worksheet to a data source, use the WorksheetDataBindingCollection.BindToDataSource method.

To use a cell range as a data source for a data-aware control, create a data source object from the required cell range using the WorksheetDataBindingCollection.CreateDataSource method.

For more information on the data binding functionality of the SpreadsheetControl, refer to the Data Binding topic.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataBindings property.

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#

how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285/CS/DataBindingToListExample/Form1.cs#L13

#region #DataBindingErrorHandling
spreadsheetControl1.Document.Worksheets[0].DataBindings.Error += DataBindings_Error;
#endregion #DataBindingErrorHandling

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-wpf-spreadsheet-t480591/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.cs#L38

    // Load data from the "Suppliers" data table into the worksheet starting from the cell "B12".
    sheet.DataBindings.BindToDataSource(dataSet.Suppliers, 11, 1);
}

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-t472324/CS/SuppliersExample/Form1.cs#L32

    // Load data from the "Suppliers" data table into the worksheet starting from the cell "B12".
    sheet.DataBindings.BindToDataSource(dataSet.Suppliers, 11, 1);
}

an-example-of-using-a-cell-range-as-a-data-source-t483776/CS/RangeDataSourceForSnap/Form1.cs#L40

rangeDS = dataRange.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;
#endregion #RangeAsDataSource

wpf-spreadsheet-how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t484261/CS/DataBindingToListExample/MainWindow.xaml.cs#L57

Worksheet sheet = spreadsheetControl1.Document.Worksheets[0];
WorksheetDataBinding sheetDataBinding = sheet.DataBindings.BindToDataSource(weatherDatasource, 2, 1, dsOptions);
#endregion #BindTheList

VB.NET

how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285/VB/DataBindingToListExample/Form1.vb#L15

'            #Region "#DataBindingErrorHandling"
            AddHandler spreadsheetControl1.Document.Worksheets(0).DataBindings.Error, AddressOf DataBindings_Error
'            #End Region ' #DataBindingErrorHandling

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-wpf-spreadsheet-t480591/VB/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.vb#L36

    ' Load data from the "Suppliers" data table into the worksheet starting from the cell "B12".
    sheet.DataBindings.BindToDataSource(dataSet.Suppliers, 11, 1)
End Sub

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-t472324/VB/SuppliersExample/Form1.vb#L32

    ' Load data from the "Suppliers" data table into the worksheet starting from the cell "B12".
    sheet.DataBindings.BindToDataSource(dataSet.Suppliers, 11, 1)
End Sub

an-example-of-using-a-cell-range-as-a-data-source-t483776/VB/RangeDataSourceForSnap/Form1.vb#L43

            rangeDS = dataRange.GetDataSource(options)
            AddHandler sheet.DataBindings.Error, AddressOf DataBindings_Error
'            #End Region ' #RangeAsDataSource

wpf-spreadsheet-how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t484261/VB/DataBindingToListExample/MainWindow.xaml.vb#L60

            Dim sheet As Worksheet = spreadsheetControl1.Document.Worksheets(0)
            Dim sheetDataBinding As WorksheetDataBinding = sheet.DataBindings.BindToDataSource(weatherDatasource, 2, 1, dsOptions)
'            #End Region ' #BindTheList