WorksheetTableDataBinding Interface

Contains information about a Table bound to an external data source or used to create a data source.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

public interface WorksheetTableDataBinding :
    WorksheetDataBinding

VB.NET

Public Interface WorksheetTableDataBinding
    Inherits WorksheetDataBinding

Related API Members

The following members accept/return WorksheetTableDataBinding objects:

• WorksheetDataBindingCollection.BindTableToDataSource(Object)
• WorksheetDataBindingCollection.BindTableToDataSource(Object, Int32, Int32)
• WorksheetDataBindingCollection.BindTableToDataSource(Object, Int32, Int32, ExternalDataSourceOptions)
• WorksheetDataBindingCollection.BindTableToDataSource(Object, Range)
• WorksheetDataBindingCollection.BindTableToDataSource(Object, Range, ExternalDataSourceOptions)

Remarks

The WorksheetTableDataBinding objects, as well as the WorksheetDataBinding objects, are contained in the WorksheetDataBindingCollection, accessible using the Worksheet.DataBindings property. Cast the item in the collection to the WorksheetTableDataBinding type to obtain the WorksheetTableDataBinding object.

The WorksheetTableDataBinding object is created, added to the Worksheet.DataBindings collection and returned by the WorksheetDataBindingCollection.BindTableToDataSource method. The Table.GetDataSource method also creates a WorksheetTableDataBinding object and adds it to the worksheet’s collection.

When the WorksheetTableDataBinding object is deleted, the associated table remains with its data. When the associated table is deleted, the WorksheetTableDataBinding object is also deleted.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t480285

Form1.cs

private void BindWeatherReportToTable(object weatherDatasource, Range bindingRange) {
    Worksheet sheet = spreadsheetControl1.Document.Worksheets[0];

    // Remove all data bindings bound to the specified data source.
    sheet.DataBindings.Remove(weatherDatasource);

    // Specify the binding options.
    ExternalDataSourceOptions dsOptions = new ExternalDataSourceOptions();
    dsOptions.ImportHeaders = true;
    dsOptions.CellValueConverter = new MyWeatherConverter();
    dsOptions.SkipHiddenRows = true;

    // Create a table and bind the data source to the table.
    try {
        WorksheetTableDataBinding sheetDataBinding = sheet.DataBindings.BindTableToDataSource(weatherDatasource, bindingRange, dsOptions);
        sheetDataBinding.Table.Style = spreadsheetControl1.Document.TableStyles[BuiltInTableStyleId.TableStyleMedium14];

        // Adjust the column width.
        sheetDataBinding.Range.AutoFitColumns();
    }
    catch(Exception e) {
        MessageBox.Show(e.Message, "Binding Exception");
    }
}

Form1.vb

Private Sub BindWeatherReportToTable(ByVal weatherDatasource As Object, ByVal bindingRange As Range)
    Dim sheet As Worksheet = spreadsheetControl1.Document.Worksheets(0)

    ' Remove all data bindings bound to the specified data source.
    sheet.DataBindings.Remove(weatherDatasource)

    ' Specify the binding options.
    Dim dsOptions As New ExternalDataSourceOptions()
    dsOptions.ImportHeaders = True
    dsOptions.CellValueConverter = New MyWeatherConverter()
    dsOptions.SkipHiddenRows = True

    ' Create a table and bind the data source to the table.
    Try
        Dim sheetDataBinding As WorksheetTableDataBinding = sheet.DataBindings.BindTableToDataSource(weatherDatasource, bindingRange, dsOptions)
        sheetDataBinding.Table.Style = spreadsheetControl1.Document.TableStyles(BuiltInTableStyleId.TableStyleMedium14)

        ' Adjust the column width.
        sheetDataBinding.Range.AutoFitColumns()
    Catch e As Exception
        MessageBox.Show(e.Message, "Binding Exception")
    End Try
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the WorksheetTableDataBinding interface.

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#L75

try {
    WorksheetTableDataBinding sheetDataBinding = sheet.DataBindings.BindTableToDataSource(weatherDatasource, bindingRange, dsOptions);
    sheetDataBinding.Table.Style = spreadsheetControl1.Document.TableStyles[BuiltInTableStyleId.TableStyleMedium14];

VB.NET

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

Try
    Dim sheetDataBinding As WorksheetTableDataBinding = sheet.DataBindings.BindTableToDataSource(weatherDatasource, bindingRange, dsOptions)
    sheetDataBinding.Table.Style = spreadsheetControl1.Document.TableStyles(BuiltInTableStyleId.TableStyleMedium14)