Use the Excel Export API to Create a New Document

Sep 19, 2023
4 minutes to read

To create a new document using the Excel Export API, do the following.

Use the XlExport.CreateExporter method to create an object exposing the IXlExporter interface to perform an export to the specified file format.
Call the IXlExporter.CreateDocument method to create a new document and to write it to the specified file stream.

Note

When you finish working with the IXlDocument 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 IXlDocument object within the using statement ( Using block in Visual Basic).

C#
VB.NET

csharp

// Create an exporter instance. 
IXlExporter exporter = XlExport.CreateExporter(XlDocumentFormat.Xlsx);
// Create the FileStream object with the specified file path. 
using (FileStream stream = new FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite))
{

    // Create a new document and write it to the specified stream. 
    using (IXlDocument document = exporter.CreateDocument(stream))
    {
        // your code here
    }
}

' Create an exporter instance. 
Dim exporter As IXlExporter = XlExport.CreateExporter(XlDocumentFormat.Xlsx)
' Create the FileStream object with the specified file path. 
Using stream As New FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite)

    ' Create a new document and write it to the specified stream. 
    Using document As IXlDocument = exporter.CreateDocument(stream)
        ' your code here
    End Using
End Using

After a workbook is generated, you can create other spreadsheet elements, such as worksheets, rows and columns, and cells.

Manage Export Options for a Created Document

Use the IXlDocument.Options property to specify export options. The code sample below specifies culture settings for a created document:

C#
VB.NET

csharp

// Create an exporter instance. 
IXlExporter exporter = XlExport.CreateExporter(XlDocumentFormat.Xlsx);
// Create the FileStream object with the specified file path. 
using (FileStream stream = new FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite)) {

    // Create a new document and write it to the specified stream. 
    using (IXlDocument document = exporter.CreateDocument(stream)) {

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

' Create an exporter instance. 
Dim exporter As IXlExporter = XlExport.CreateExporter(XlDocumentFormat.Xlsx)

' Create the FileStream object with the specified file path. 
Using stream As New FileStream("Document.xlsx", FileMode.Create, FileAccess.ReadWrite)

    ' Create a new document and write it to the specified stream. 
    Using document As IXlDocument = exporter.CreateDocument(stream)

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

CSV Export Options

Cast the IXlDocument.Options property to the CsvDataAwareExporterOptions class to specify options to export the document to CSV format.

The code sample below shows how to specify CsvDataAwareExporterOptions:

C#
VB.NET

// Create an exporter instance.
IXlExporter exporter = XlExport.CreateExporter(documentFormat);

// Create a new document.
using(IXlDocument document = exporter.CreateDocument(stream)) {
    document.Options.Culture = CultureInfo.CurrentCulture;

    // Specify CSV export options.
    CsvDataAwareExporterOptions csvOptions = document.Options as CsvDataAwareExporterOptions;
    if(csvOptions != null) {

        // Set the encoding of the text-based file to which the workbook is exported.
        csvOptions.Encoding = Encoding.UTF8;

        // Write a preamble that specifies the used encoding.
        csvOptions.WritePreamble = true;

        // Use the current culture's format string to convert a cell value to a string. 
        csvOptions.UseCellNumberFormat = false;

        // Insert the newline character after the last row of the resulting text.
        csvOptions.NewlineAfterLastRow = true;
    }
}

' Create an exporter instance.
Dim exporter As IXlExporter = XlExport.CreateExporter(documentFormat)

' Create a new document.
Using document As IXlDocument = exporter.CreateDocument(stream)
    document.Options.Culture = CultureInfo.CurrentCulture

    ' Specify CSV export options.
    Dim csvOptions As CsvDataAwareExporterOptions = TryCast(document.Options, CsvDataAwareExporterOptions)
    If csvOptions IsNot Nothing Then

        ' Set the encoding of the text-based file to which the workbook is exported.
        csvOptions.Encoding = Encoding.UTF8

        ' Write a preamble that specifies the used encoding.
        csvOptions.WritePreamble = True

        ' Use the current culture's format string to convert a cell value to a string. 
        csvOptions.UseCellNumberFormat = False

        ' Insert the newline character after the last row of the resulting text.
        csvOptions.NewlineAfterLastRow = True
    End If
End Using