How to: Create a New Worksheet

• Apr 12, 2019

The example below demonstrates how to add a worksheet to a workbook. To do this, use the IXlDocument.CreateSheet method.

To specify a worksheet name, use the IXlSheet.Name property. When naming a worksheet, take into account the constraints listed in the How to: Set a Worksheet Name document. If you do not specify a worksheet name, the default name “SheetN” is used, where N is a sequential number of a worksheet within a workbook.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/xl-export-api-examples-t253492

GeneralActions.cs

// Create a new document.
using (IXlDocument document = exporter.CreateDocument(stream)) {

    // Specify the document culture.
    document.Options.Culture = CultureInfo.CurrentCulture;

    // Create a new worksheet under the specified name. 
    using (IXlSheet sheet = document.CreateSheet()) {
        sheet.Name = "Sales report";
    }
}

GeneralActions.vb

' Create a new document.
Using document As IXlDocument = exporter.CreateDocument(stream)

    ' Specify the document culture.
    document.Options.Culture = CultureInfo.CurrentCulture

    ' Create a new worksheet under the specified name. 
    Using sheet As IXlSheet = document.CreateSheet()
        sheet.Name = "Sales report"
    End Using
End Using