Use the Excel Export API to Create a New Worksheet

• Sep 19, 2023
• 2 minutes to read

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

When you finish working with the IXlSheet object, call the Dispose method to release all the resources used by the object. Otherwise, generated content is not written to the output file. You can also modify the IXlSheet object within the using statement (Using block in Visual Basic).

View Example

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