ExcelDataSource.SourceOptions Property

Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

Namespace: DevExpress.DataAccess.Excel

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

[LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)]
[TypeConverter(typeof(ExcelDataSource.ExcelObscuredTypeConverter))]
public ExcelSourceOptionsBase SourceOptions { get; set; }

VB.NET

<LocalizableCategory(DataAccessStringId.PropertyGridDataCategoryName)>
<TypeConverter(GetType(ExcelDataSource.ExcelObscuredTypeConverter))>
Public Property SourceOptions As ExcelSourceOptionsBase

Property Value

Type	Description
ExcelSourceOptionsBase	A ExcelSourceOptionsBase descendant containing options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SourceOptions property.

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#

data-access-library-create-data-sources-at-runtime/CS/ExcelDataSourceSnippets/Code.cs#L23

    csvSourceOptions.DetectValueSeparator = true;
    excelDataSource.SourceOptions = csvSourceOptions;
}

winforms-grid-open-excel-files/CS/Form1.cs#L21

var worksheetSettings = new ExcelWorksheetSettings("Sheet1", "A1:B3");
source.SourceOptions = new ExcelSourceOptions(worksheetSettings);
source.Fill();

asp-net-mvc-grid-upload-excel-file-using-upload-control-and-display-data-in-grid/CS/T449148/Models/Model.cs#L34

excelSourceOptions.UseFirstRowAsHeader = true;
excelDataSource.SourceOptions = excelSourceOptions;

reporting-winforms-bind-to-csv-file/CS/BindingReportToCsvFile/Form1.cs#L31

};
excelDataSource.SourceOptions = csvSourceOptions;

winforms-dashboard-grid-hyperlink-column/CS/Dashboard_GridHyperlinkColumn/Form1.cs#L17

excelDataSource.FileName = @"..\..\Data\GDPByCountry.xlsx";
excelDataSource.SourceOptions = new ExcelSourceOptions(new ExcelWorksheetSettings("Sheet1"));
dashboard.DataSources.Add(excelDataSource);

VB.NET

data-access-library-create-data-sources-at-runtime/VB/ExcelDataSourceSnippets/Code.vb#L21

    csvSourceOptions.DetectValueSeparator = True
    excelDataSource.SourceOptions = csvSourceOptions
End Sub

winforms-grid-open-excel-files/VB/Form1.vb#L16

Dim worksheetSettings = New ExcelWorksheetSettings("Sheet1", "A1:B3")
source.SourceOptions = New ExcelSourceOptions(worksheetSettings)
source.Fill()

asp-net-mvc-grid-upload-excel-file-using-upload-control-and-display-data-in-grid/VB/T449148_VB/Models/Model.vb#L19

excelSourceOptions.UseFirstRowAsHeader = True
excelDataSource.SourceOptions = excelSourceOptions
excelDataSource.Fill()

reporting-winforms-bind-to-csv-file/VB/BindingReportToCsvFile/Form1.vb#L23

Dim csvSourceOptions As CsvSourceOptions = New CsvSourceOptions With {.DetectEncoding = True, .DetectNewlineType = True, .DetectValueSeparator = True}
excelDataSource.SourceOptions = csvSourceOptions
' Define the data source schema.

reporting-winforms-bind-excel-runtime/VB/BindingReportToExcelWorkbook/Form1.vb#L31

excelSourceOptions.SkipHiddenColumns = False
excelDataSource.SourceOptions = excelSourceOptions
' Create new fields and specify their settings.