officefileapi-devexpress-dot-spreadsheet-dot-table-dot-getdatasource-x28-devexpress-dot-spreadsheet-dot-rangedatasourceoptions-x29.md
Creates the data source from the worksheet table using the specified options.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
object GetDataSource(
RangeDataSourceOptions options
)
Function GetDataSource(
options As RangeDataSourceOptions
) As Object
| Name | Type | Description |
|---|---|---|
| options | RangeDataSourceOptions |
A RangeDataSourceOptions object containing the data source options.
|
| Type | Description |
|---|---|
| Object |
An object that is the created data source.
|
The method also creates the WorksheetTableDataBinding object and adds it to the Worksheet.DataBindings collection.
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;
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
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.
var document = richEditControl1.Document;
RangeDataSource rows = wb.Worksheets[0].Tables[0].GetDataSource(options) as RangeDataSource;
var columns = rows[0].GetProperties();
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;
Dim document = RichEditControl1.Document
Dim rows As RangeDataSource = TryCast(wb.Worksheets(0).Tables(0).GetDataSource(options), RangeDataSource)
Dim columns = rows(0).GetProperties()
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
See Also