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

WorksheetCollection.Remove(Worksheet) Method

Removes the specified worksheet from the collection.

Namespace: DevExpress.Spreadsheet

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

Declaration

void Remove(
    Worksheet worksheet
)
Sub Remove(
    worksheet As Worksheet
)

Parameters

Name Type Description
worksheet Worksheet

A Worksheet object specifying a worksheet to be removed from a workbook.

Remarks

The Remove method disposes of an element removed from the collection. To remove a worksheet by its index in the collection, use the WorksheetCollection.RemoveAt 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