ExcelSourceOptionsBase.UseFirstRowAsHeader Property

Gets or sets whether to process the values of the first row as headers.

Namespace: DevExpress.DataAccess.Excel

Assembly: DevExpress.DataAccess.v23.2.dll

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

Declaration

C#

[DefaultValue(true)]
public bool UseFirstRowAsHeader { get; set; }

VB.NET

<DefaultValue(True)>
Public Property UseFirstRowAsHeader As Boolean

Property Value

Type	Default	Description
Boolean	true	true, to process the values of the first row as headers; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to UseFirstRowAsHeader
Cross-Platform Class Library	BeforeFillEventArgs	.SourceOptions .UseFirstRowAsHeader
	ExcelDataSource	.SourceOptions .UseFirstRowAsHeader
	DataSourceModel	.SourceOptions .UseFirstRowAsHeader
	ExcelDataSourceModel	.SourceOptions .UseFirstRowAsHeader
	IExcelDataSourceModel	.SourceOptions .UseFirstRowAsHeader
	IChooseFileOptionsPageView	.SourceOptions .UseFirstRowAsHeader
WinForms Controls	ChooseFileOptionsPageView	.SourceOptions .UseFirstRowAsHeader
Reporting	XtraReportModel	.SourceOptions .UseFirstRowAsHeader
Dashboard	DashboardExcelDataSourceBeforeFillEventArgs	.SourceOptions .UseFirstRowAsHeader
	ExcelDataSourceBeforeFillEventArgs	.SourceOptions .UseFirstRowAsHeader

Remarks

When the UseFirstRowAsHeader property is set to true, field names for the ExcelDataSource are generated based on the values of the first row. If necessary, you can disable the UseFirstRowAsHeader flag and create a custom schema for the ExcelDataSource using the ExcelDataSource.Schema property.

Note

If you set the UseFirstRowAsHeader property to false and do not provide the data source schema, field names will be generated automatically.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UseFirstRowAsHeader 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#

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

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

wpf-pivot-grid-show-top-n-values-in-context-menu/CS/ContextMenuToShowTopN_Example/MainWindow.xaml.cs#L31

xlDataSource.SourceOptions.SkipEmptyRows = false;
xlDataSource.SourceOptions.UseFirstRowAsHeader = true;
xlDataSource.Fill();

VB.NET

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

excelSourceOptions.SkipHiddenColumns = False
excelSourceOptions.UseFirstRowAsHeader = True
excelDataSource.SourceOptions = excelSourceOptions

wpf-pivot-grid-show-top-n-values-in-context-menu/VB/ContextMenuToShowTopN_Example/MainWindow.xaml.vb#L29

xlDataSource.SourceOptions.SkipEmptyRows = False
xlDataSource.SourceOptions.UseFirstRowAsHeader = True
xlDataSource.Fill()