IXlDocument.CreateSheet() Method

Creates a new worksheet in the workbook and returns the IXlSheet object.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v19.1.Core.dll

Declaration

C#

IXlSheet CreateSheet()

VB.NET

Function CreateSheet As IXlSheet

Returns

Type	Description
IXlSheet	An IXlSheet object that is the newly created worksheet.

Example

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

Related GitHub Examples

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

excel-export-api-examples-t253492/CS/XLExportExamples/SpreadsheetActions/PictureActions.cs#L32

// Create a worksheet.
using (IXlSheet sheet = document.CreateSheet())
{

how-to-copy-cell-data-in-an-excel-format-biff8-to-the-clipboard-using-xl-export-library-t266171/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L144

using(IXlDocument document = exporter.CreateDocument(dataStream)) {
    using(IXlSheet sheet = document.CreateSheet()) {
        ExportColumns(sheet);

VB.NET

excel-export-api-examples-t253492/VB/XLExportExamples/SpreadsheetActions/PictureActions.vb#L31

' Create a worksheet.
Using sheet As IXlSheet = document.CreateSheet()

how-to-copy-cell-data-in-an-excel-format-biff8-to-the-clipboard-using-xl-export-library-t266171/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L147

Using document As IXlDocument = exporter.CreateDocument(dataStream)
    Using sheet As IXlSheet = document.CreateSheet()
        ExportColumns(sheet)