Range.GetDataSource(RangeDataSourceOptions) Method

Creates the data source from the current cell range using the specified options.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

object GetDataSource(
    RangeDataSourceOptions options
)

VB.NET

Function GetDataSource(
    options As RangeDataSourceOptions
) As Object

Parameters

Name	Type	Description
options	RangeDataSourceOptions	A RangeDataSourceOptions object containing the data source options.

Returns

Type	Description
Object	An object that is the created data source.

Remarks

Another method that creates the data source from a worksheet range is the WorksheetDataBindingCollection.CreateDataSource method. It creates a worksheet data binding and adds it to the collection. To obtain a data source associated with a particular binding, use the WorksheetDataBinding.DataSource property.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/an-example-of-using-a-cell-range-as-a-data-source-t483776

Form1.cs

RangeDataSourceOptions options = new RangeDataSourceOptions();
Worksheet sheet = spreadsheetControl1.ActiveWorksheet;
Range dataRange = sheet.Selection;
if (dataRange.Equals(sheet.Tables[0].Range))
    options.UseFirstRowAsHeader = true;
else {
    options.UseFirstRowAsHeader = false;
    options.DataSourceColumnTypeDetector = new MyColumnDetector();
}
options.SkipHiddenColumns = true;
rangeDS = dataRange.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;

Form1.vb

Dim options As New RangeDataSourceOptions()
Dim sheet As Worksheet = spreadsheetControl1.ActiveWorksheet
Dim dataRange As Range = sheet.Selection
If dataRange.Equals(sheet.Tables(0).Range) Then
    options.UseFirstRowAsHeader = True
Else
    options.UseFirstRowAsHeader = False
    options.DataSourceColumnTypeDetector = New MyColumnDetector()
End If
options.SkipHiddenColumns = True
rangeDS = dataRange.GetDataSource(options)
AddHandler sheet.DataBindings.Error, AddressOf DataBindings_Error

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDataSource(RangeDataSourceOptions) 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#

how-to-bind-a-grid-control-to-the-worksheet-data-wpf-spreadsheet-t461395/CS/WpfSpreadsheet_DataBinding/MainWindow.xaml.cs#L32

// Bind the grid control to the table data.
grid.ItemsSource = expensesTable.DataRange.GetDataSource(options);
#endregion #BindGridToSpreadsheetTable

how-to-bind-a-grid-control-to-the-worksheet-data-t461090/CS/Spreadsheet_BindToDataSource/Form1.cs#L27

// Bind the grid control to the table data.
gridControl1.DataSource = expensesTable.DataRange.GetDataSource(options);
#endregion #BindGridToSpreadsheetTable

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

options.SkipHiddenColumns = true;
rangeDS = dataRange.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;

VB.NET

how-to-bind-a-grid-control-to-the-worksheet-data-wpf-spreadsheet-t461395/VB/WpfSpreadsheet_DataBinding/MainWindow.xaml.vb#L30

            ' Bind the grid control to the table data.
            grid.ItemsSource = expensesTable.DataRange.GetDataSource(options)
'            #End Region ' #BindGridToSpreadsheetTable

how-to-bind-a-grid-control-to-the-worksheet-data-t461090/VB/Spreadsheet_BindToDataSource/Form1.vb#L25

            ' Bind the grid control to the table data.
            gridControl1.DataSource = expensesTable.DataRange.GetDataSource(options)
'            #End Region ' #BindGridToSpreadsheetTable

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

options.SkipHiddenColumns = True
rangeDS = dataRange.GetDataSource(options)
AddHandler sheet.DataBindings.Error, AddressOf DataBindings_Error