RangeDataSourceOptions Class

Contains various options for a data source created from a cell range.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

public class RangeDataSourceOptions :
    DataSourceOptionsBase

VB.NET

Public Class RangeDataSourceOptions
    Inherits DataSourceOptionsBase

Remarks

A RangeDataSourceOptions object is created and passed as a parameter to the Range.GetDataSource or the WorksheetDataBindingCollection.CreateDataSource methods.

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

spreadsheet-document-api-how-to-use-a-worksheet-as-a-data-source-for-the-snap-report-t518070/CS/SpreadsheetDocumentServerAsDataSourceExample/Form1.cs#L17

wb.LoadDocument("Employees.xlsx");
DevExpress.Spreadsheet.RangeDataSourceOptions options =
    new DevExpress.Spreadsheet.RangeDataSourceOptions();

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

#region #RangeAsDataSource
RangeDataSourceOptions options = new RangeDataSourceOptions();
Worksheet sheet = spreadsheetControl1.ActiveWorksheet;

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

// Specify the data source settings.
RangeDataSourceOptions options = new RangeDataSourceOptions();
options.PreserveFormulas = true;

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

// Specify the data source settings.
RangeDataSourceOptions options = new RangeDataSourceOptions();
options.PreserveFormulas = true;

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/CS/SnapAndSpreadsheetDocumentServerExample/XDataSourceHelper.cs#L9

wb.LoadDocument("Employees.xlsx");
RangeDataSourceOptions options = new RangeDataSourceOptions();
options.UseFirstRowAsHeader = true;

VB.NET

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

'            #Region "#RangeAsDataSource"
            Dim options As New RangeDataSourceOptions()
            Dim sheet As Worksheet = spreadsheetControl1.ActiveWorksheet

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

' Specify the data source settings.
Dim options As New RangeDataSourceOptions()
options.PreserveFormulas = True

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

' Specify the data source settings.
Dim options As New RangeDataSourceOptions()
options.PreserveFormulas = True

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/VB/SnapAndSpreadsheetDocumentServerExample/XDataSourceHelper.vb#L13

wb.LoadDocument("Employees.xlsx")
Dim options As New RangeDataSourceOptions()
options.UseFirstRowAsHeader = True

spreadsheet-document-api-how-to-use-a-worksheet-as-a-data-source-for-the-snap-report-t518070/VB/SpreadsheetDocumentServerAsDataSourceExample/Form1.vb#L18

wb.LoadDocument("Employees.xlsx")
Dim options As New DevExpress.Spreadsheet.RangeDataSourceOptions()
options.UseFirstRowAsHeader = True

Inheritance

Object

DataSourceOptionsBase

RangeDataSourceOptions