.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

WorksheetCollection.RemoveAt(Int32) Method

Removes the worksheet at the specified position from the collection.

Namespace: DevExpress.Spreadsheet

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

Declaration

void RemoveAt(
    int index
)
Sub RemoveAt(
    index As Integer
)

Parameters

Name Type Description
index Int32

An integer that is the zero-based index of a worksheet to be deleted from a workbook.

Remarks

The RemoveAt method disposes of an element removed from the collection. To remove the specified worksheet from the collection, use the WorksheetCollection.Remove method. You can also hide worksheets (see the How to: Show and Hide a Worksheet topic for details).

NOTE

A workbook must always contain at least one visible worksheet.

To add new worksheets to a workbook, use the WorksheetCollection.Add or WorksheetCollection.Insert method.

Examples

This example demonstrates how to remove a worksheet from a workbook by calling the WorksheetCollection.Remove or WorksheetCollection.RemoveAt method of the WorksheetCollection object that is accessed via the Workbook.Worksheets property.

// Delete the "Sheet2" worksheet from the workbook.
workbook.Worksheets.Remove(workbook.Worksheets["Sheet2"]);

// Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0);
See Also