ExcelWorksheetSettings.WorksheetIndex Property

Allows you to bind an application or component to a sheet of an Excel file by index.

Namespace: DevExpress.DataAccess.Excel

Assembly: DevExpress.DataAccess.v24.2.dll

Declaration

C#

public int? WorksheetIndex { get; set; }

VB.NET

Public Property WorksheetIndex As Integer?

Property Value

Type	Description
Nullable<Int32>	The zero-based index of an Excel sheet to which an application or component is bound.

Remarks

The WorksheetIndex property uses zero-based indexing. The property has no effect if the WorksheetName property is specified.

Example

The example below demonstrates how to specify the WorksheetIndex property to bind an application or component to a sheet of an Excel file by index.

C#

using DevExpress.DataAccess.Excel;
// ...
var excelDataSource = new ExcelDataSource() {
    FileName = "Path\\To\\Excel\\File.xlsx"
};

var excelWorksheetSettings = new ExcelWorksheetSettings() {
    WorksheetIndex = 0
};

var excelSourceOptions = new ExcelSourceOptions() {
    ImportSettings = excelWorksheetSettings,
    //...
};

excelDataSource.SourceOptions = excelSourceOptions;
excelDataSource.Fill();
//...

VB.NET

Imports DevExpress.DataAccess.Excel
' ...
Dim excelDataSource = New ExcelDataSource() With {.FileName = "Path\To\Excel\File.xlsx"}

Dim excelWorksheetSettings = New ExcelWorksheetSettings() With {.WorksheetIndex = 0}

Dim excelSourceOptions = New ExcelSourceOptions() With {.ImportSettings = excelWorksheetSettings}

excelDataSource.SourceOptions = excelSourceOptions
excelDataSource.Fill()
'...