The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

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.v19.1.Core.dll

Declaration

public interface WorksheetTableDataBinding :
    WorksheetDataBinding
Public Interface WorksheetTableDataBinding
    Inherits WorksheetDataBinding
public interface WorksheetTableDataBinding :
    WorksheetDataBinding
Public Interface WorksheetTableDataBinding
    Inherits WorksheetDataBinding

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.

Examples

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");
    }
}
See Also