WorksheetCollection.Remove(Worksheet) Method
Removes the specified worksheet from the collection.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v18.2.Core.dll
Declaration
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.
Example
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.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/spreadsheet-document-server-api-e4339
// Delete the "Sheet2" worksheet from the workbook.
workbook.Worksheets.Remove(workbook.Worksheets["Sheet2"]);
// Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0);
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the Remove(Worksheet) method.
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.