ExternalDataSourceOptions Class

Contains options for data retrieval from an external data source when establishing a data binding.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

public class ExternalDataSourceOptions :
    DataSourceOptionsBase

VB.NET

Public Class ExternalDataSourceOptions
    Inherits DataSourceOptionsBase

Remarks

An ExternalDataSourceOptions class instance is assigned as a parameter to the WorksheetDataBindingCollection.BindToDataSource method.

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 BindWeatherReportToRange(object weatherDatasource, Range bindingRange) {
    Worksheet sheet = spreadsheetControl1.Document.Worksheets[0];

    // Check for range conflicts.
    var dataBindingConflicts = sheet.DataBindings.
        Where(d => (d.Range.RightColumnIndex >= bindingRange.LeftColumnIndex) || (d.Range.BottomRowIndex >= bindingRange.TopRowIndex)) ;
    if (dataBindingConflicts.Count() > 0) {
        MessageBox.Show("Cannot bind the range to data.\r\nThe worksheet contains other binding ranges which may conflict.", "Range Conflict");
        return;
    }

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

    // Bind the data source to the worksheet range.
    WorksheetDataBinding sheetDataBinding = sheet.DataBindings.BindToDataSource(weatherDatasource, bindingRange, dsOptions);

    // Adjust the column width.
    sheetDataBinding.Range.AutoFitColumns();
}

Form1.vb

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

    ' Check for range conflicts.
    Dim dataBindingConflicts = sheet.DataBindings.Where(Function(d) (d.Range.RightColumnIndex >= bindingRange.LeftColumnIndex) OrElse (d.Range.BottomRowIndex >= bindingRange.TopRowIndex))
    If dataBindingConflicts.Count() > 0 Then
        MessageBox.Show("Cannot bind the range to data." & ControlChars.CrLf & "The worksheet contains other binding ranges which may conflict.", "Range Conflict")
        Return
    End If

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

    ' Bind the data source to the worksheet range.
    Dim sheetDataBinding As WorksheetDataBinding = sheet.DataBindings.BindToDataSource(weatherDatasource, bindingRange, dsOptions)

    ' Adjust the column width.
    sheetDataBinding.Range.AutoFitColumns()
End Sub

Related GitHub Examples

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

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

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

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

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

VB.NET

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

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

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

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

Inheritance

Object

DataSourceOptionsBase

ExternalDataSourceOptions