CellRange.GetDataSource(RangeDataSourceOptions) Method

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

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

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

View Example

Form1.cs

RangeDataSourceOptions options = new RangeDataSourceOptions();
Worksheet sheet = spreadsheetControl1.ActiveWorksheet;
CellRange 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 CellRange = 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#

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

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

winforms-spreadsheet-use-cell-range-as-data-source/CS/RangeDataSource/Form1.cs#L38

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

VB.NET

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

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

winforms-spreadsheet-use-cell-range-as-data-source/VB/RangeDataSource/Form1.vb#L43

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