Worksheet.Index Property

Gets the worksheet index within the workbook’s WorksheetCollection collection.

Assembly: DevExpress.Spreadsheet.v21.2.Core.dll

Declaration

C#
VB.NET

int Index { get; }

ReadOnly Property Index As Integer

Property Value

Type	Description
Int32	An integer value specifying a zero-based index of the worksheet.

Remarks

Use the Index property to obtain the position of the worksheet within the workbook’s collection of worksheets (IWorkbook.Worksheets). Note that a workbook must always contain at least one visible sheet.

Worksheet Indexes

To move a worksheet to another location in a workbook, use the Worksheet.Move method, or methods inherited from the Sheet interface: Sheet.MoveToBeginning, Sheet.MoveBefore, Sheet.MoveAfter, or Sheet.MoveToEnd (for details, see the How to: Move a Worksheet to Another Location in a Workbook example).

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

wpf-spreadsheetcontrol-api-part-2-e4944/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ExportActions.cs#L33

// Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index;
options.Range = "B11:O28";

winforms-spreadsheetcontrol-api-part-2-e4832/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/ExportActions.cs#L31

// Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index;
options.Range = "B11:O28";

spreadsheet-document-api-examples-part-2-t217615/CS/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.cs#L18

// Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index;
options.Range = "B2:G7";

how-to-implement-a-service-to-manage-the-process-of-worksheet-cell-calculation-t270403/CS/CustomCalculationServiceExample/Form1.cs#L35

{
    CellKey cellkey = new CellKey((e.Cell.Worksheet.Index + 1), e.Cell.ColumnIndex, e.Cell.RowIndex);
    if (calculationService.CircularReferencedCells.Contains(cellkey))

wpf-spreadsheetcontrol-api-part-2-e4944/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ExportActions.vb#L30

' Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index
options.Range = "B11:O28"

winforms-spreadsheetcontrol-api-part-2-e4832/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/ExportActions.vb#L28

' Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index
options.Range = "B11:O28"

spreadsheet-document-api-examples-part-2-t217615/VB/SpreadsheetDocServerAPIPart2/CodeExamples/ExportActions.vb#L19

' Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index
options.Range = "B2:G7"

how-to-implement-a-service-to-manage-the-process-of-worksheet-cell-calculation-t270403/VB/CustomCalculationServiceExample/Form1.vb#L33

Private Sub spreadsheetControl1_CustomDrawCell(ByVal sender As Object, ByVal e As DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs)
    Dim cellkey As New CellKey((e.Cell.Worksheet.Index + 1), e.Cell.ColumnIndex, e.Cell.RowIndex)
    If calculationService.CircularReferencedCells.Contains(cellkey) Then

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

.NET Subscription

Common Tools

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Worksheet.Index Property

Declaration

Property Value

Remarks

Worksheet.Index Property

Declaration

Property Value

Remarks

Related GitHub Examples