Table.GetDataSource(RangeDataSourceOptions) Method

Creates the data source from the worksheet table using the specified options.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.2.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

The method also creates the WorksheetTableDataBinding object and adds it to the Worksheet.DataBindings collection.

Example

View Example

Form1.cs

RangeDataSourceOptions options = new RangeDataSourceOptions();
Worksheet sheet = spreadsheetControl1.ActiveWorksheet;
Table sheetDataTable = sheet.Tables[0];
if (sheetDataTable.ShowHeaders)
    options.UseFirstRowAsHeader = true;
else {
    options.UseFirstRowAsHeader = false;
}
options.EditingOptions = DataSourceEditingOptions.ReadOnly;
options.SkipHiddenColumns = false;
rangeDS = sheetDataTable.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;

Form1.vb

Dim options As New RangeDataSourceOptions()
Dim sheet As Worksheet = spreadsheetControl1.ActiveWorksheet
Dim sheetDataTable As Table = sheet.Tables(0)
If sheetDataTable.ShowHeaders Then
    options.UseFirstRowAsHeader = True
Else
    options.UseFirstRowAsHeader = False
End If
options.EditingOptions = DataSourceEditingOptions.ReadOnly
options.SkipHiddenColumns = False
rangeDS = sheetDataTable.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#

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

options.SkipHiddenColumns = false;
rangeDS = sheetDataTable.GetDataSource(options);
sheet.DataBindings.Error += DataBindings_Error;

spreadsheet-document-api-use-worksheet-table-as-data-source/CS/SpreadsheetDocumentServerAsDataSourceExample/Form1.cs#L31

var document = richEditControl1.Document;
RangeDataSource rows = wb.Worksheets[0].Tables[0].GetDataSource(options) as RangeDataSource;
var columns = rows[0].GetProperties();

VB.NET

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

options.SkipHiddenColumns = False
rangeDS = sheetDataTable.GetDataSource(options)
AddHandler sheet.DataBindings.Error, AddressOf DataBindings_Error

spreadsheet-document-api-use-worksheet-table-as-data-source/VB/SpreadsheetDocumentServerAsDataSourceExample/Form1.vb#L27

Dim document = RichEditControl1.Document
Dim rows As RangeDataSource = TryCast(wb.Worksheets(0).Tables(0).GetDataSource(options), RangeDataSource)
Dim columns = rows(0).GetProperties()