officefileapi-devexpress-dot-spreadsheet-dot-worksheetcollection-dot-removeat-x28-system-dot-int32-x29.md
Removes the worksheet at the specified position from the collection.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
void RemoveAt(
int index
)
Sub RemoveAt(
index As Integer
)
| Name | Type | Description |
|---|---|---|
| index | Int32 |
An integer that is the zero-based index of a worksheet to be deleted from a workbook.
|
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.
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);
' Delete the "Sheet2" worksheet from the workbook.
workbook.Worksheets.Remove(workbook.Worksheets("Sheet2"))
' Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0)
The following code snippets (auto-collected from DevExpress Examples) contain references to the RemoveAt(Int32) 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.
winforms-spreadsheet-import-data-from-a-datatable-instance/CS/Form1.cs#L17
for (int i = count - 1; i >= 1; i--)
workbook.Worksheets.RemoveAt(i);
workbook.Worksheets[0].Name = "Default";
// Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0);
#endregion #DeleteWorksheet
// Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0);
#endregion #DeleteWorksheet
// Delete the first worksheet.
workbook.Worksheets.RemoveAt(0);
#endregion #DeleteWorksheet
winforms-spreadsheet-import-data-from-a-datatable-instance/VB/Form1.vb#L19
For i As Integer = count - 1 To 1 Step -1
workbook.Worksheets.RemoveAt(i)
Next i
' Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0)
' #End Region ' #DeleteWorksheet
' Delete the first worksheet from the workbook.
workbook.Worksheets.RemoveAt(0)
' #End Region ' #DeleteWorksheet
' Delete the first worksheet.
workbook.Worksheets.RemoveAt(0)
#End Region ' #DeleteWorksheet
See Also
How to: Move a Worksheet to another Location
How to: Show and Hide a Worksheet