IXlExporter.CreateDocument(Stream) Method

Creates a new document and writes it to the specified stream.

Namespace: DevExpress.Export.Xl

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

IXlDocument CreateDocument(
    Stream stream
)

VB.NET

Function CreateDocument(
    stream As Stream
) As IXlDocument

Parameters

Name	Type	Description
stream	Stream	The System.IO.Stream object to output the document to.

Returns

Type	Description
IXlDocument	An IXlDocument object that is the newly created workbook.

Remarks

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).

Example

The example below demonstrates how to create a new document and write it to the specified file stream using the IXlExporter.CreateDocument method.

C#

// 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;
    }
}

VB.NET

' 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateDocument(Stream) 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/CS/XLExportExamples/SpreadsheetActions/PictureActions.cs#L27

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

how-to-use-the-excel-export-api-to-generate-a-list-of-employees/CS/XLExportExample/Form1.cs#L101

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

excel-export-library-generate-sales-report/CS/XLExportExampleSalesReport/Form1.cs#L102

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

excel-export-library-generate-an-invoice/CS/XLExportExample/Form1.cs#L143

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

excel-export-library-generate-sales-analysis-report/CS/XLExportExample/Form1.cs#L105

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

VB.NET

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

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

how-to-use-the-excel-export-api-to-generate-a-list-of-employees/VB/XLExportExample/Form1.vb#L95

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

excel-export-library-generate-sales-report/VB/XLExportExampleSalesReport/Form1.vb#L112

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

excel-export-library-generate-an-invoice/VB/XLExportExample/Form1.vb#L151

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

excel-export-library-generate-sales-analysis-report/VB/XLExportExample/Form1.vb#L99

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