WorksheetCollection.Add() Method

Creates a new worksheet and appends it to the end of the collection.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

Worksheet Add()

VB.NET

Function Add As Worksheet

Returns

Type	Description
Worksheet	A Worksheet object that specifies the new worksheet.

Remarks

The Add method creates a new worksheet under a default name like SheetN, where N is a number that is greater by 1 than the maximum number used in worksheet names of the same type. To change the worksheet name, use the Worksheet.Name property.

To insert a new worksheet to the specified position in the collection, use the WorksheetCollection.Insert method.

To remove a worksheet from the collection, use the WorksheetCollection.Remove or WorksheetCollection.RemoveAt method.

Example

This example demonstrates how to add a new worksheet to a workbook. To do this, use the WorksheetCollection.Add method of the WorksheetCollection collection accessed via Workbook.Worksheets.

To insert a worksheet at the specified position in the WorksheetCollection collection, call the WorksheetCollection.Insert method with the passed worksheet zero-based index.

To specify a worksheet name, use the Worksheet.Name property or pass the worksheet name to the WorksheetCollection.Add or WorksheetCollection.Insert method as a parameter. When naming a worksheet, take into account the constraints listed in the How to: Rename a Worksheet document.

View Example

WorksheetActions.cs

// Add a new worksheet to the workbook. The worksheet will be inserted into the end of the existing worksheet collection
// under the name "SheetN", where N is a number following the largest number used in worksheet names in the previously existing collection.
workbook.Worksheets.Add();

// Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1";

workbook.Worksheets.Add("TestSheet2");

// Add a new worksheet to the specified position in the collection of worksheets.
workbook.Worksheets.Insert(1, "TestSheet3");

workbook.Worksheets.Insert(3);

WorksheetActions.vb

' Add a new worksheet to the workbook. The worksheet will be inserted into the end of the existing worksheet collection
' under the name "SheetN", where N is a number following the largest number used in worksheet names in the previously existing collection.
workbook.Worksheets.Add()

' Add a new worksheet under the specified name.
workbook.Worksheets.Add().Name = "TestSheet1"

workbook.Worksheets.Add("TestSheet2")

' Add a new worksheet to the specified position in the collection of worksheets.
workbook.Worksheets.Insert(1, "TestSheet3")

workbook.Worksheets.Insert(3)

Related GitHub Examples

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

C#

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeExamples/PivotFieldActions.cs#L11

Worksheet sourceWorksheet = workbook.Worksheets["Data1"];
Worksheet worksheet = workbook.Worksheets.Add();
workbook.Worksheets.ActiveWorksheet = worksheet;

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotFieldActions.cs#L11

Worksheet sourceWorksheet = workbook.Worksheets["Data1"];
Worksheet worksheet = workbook.Worksheets.Add();
workbook.Worksheets.ActiveWorksheet = worksheet;

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeExamples/PivotFieldActions.cs#L11

Worksheet sourceWorksheet = workbook.Worksheets["Data1"];
Worksheet worksheet = workbook.Worksheets.Add();
workbook.Worksheets.ActiveWorksheet = worksheet;

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.cs#L36

// than the maximum number used in worksheet names of the same type.
workbook.Worksheets.Add();

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/CS/WindowsFormsApplication1/MSAccessImportHelper.cs#L132

if(tableIndex > 0) {
    workSheet = wb.Worksheets.Add();
}

VB.NET

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeExamples/PivotFieldActions.vb#L12

Dim sourceWorksheet As Worksheet = workbook.Worksheets("Data1")
Dim worksheet As Worksheet = workbook.Worksheets.Add()
workbook.Worksheets.ActiveWorksheet = worksheet

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeExamples/ValueFieldSettingsActions.vb#L8

Dim sourceWorksheet As Worksheet = workbook.Worksheets("Data5")
Dim worksheet As Worksheet = workbook.Worksheets.Add()
workbook.Worksheets.ActiveWorksheet = worksheet

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeExamples/ValueFieldSettingsActions.vb#L8

Dim sourceWorksheet As Worksheet = workbook.Worksheets("Data5")
Dim worksheet As Worksheet = workbook.Worksheets.Add()
workbook.Worksheets.ActiveWorksheet = worksheet

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/WorksheetActions.vb#L47

' than the maximum number used in worksheet names of the same type.
workbook.Worksheets.Add()
' Add a new worksheet under the specified name.

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/VB/WindowsFormsApplication1/MSAccessImportHelper.vb#L149

If tableIndex > 0 Then
    workSheet = wb.Worksheets.Add()
End If