XlExport.CreateExporter(XlDocumentFormat) Method

Creates an exporter that performs data export to the specified Excel format.

Namespace: DevExpress.Export.Xl

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public static IXlExporter CreateExporter(
    XlDocumentFormat documentFormat
)

VB.NET

Public Shared Function CreateExporter(
    documentFormat As XlDocumentFormat
) As IXlExporter

Parameters

Name	Type	Description
documentFormat	XlDocumentFormat	One of the XlDocumentFormat enumeration members that specifies the type of the output document.

Returns

Type	Description
IXlExporter	An object exposing the IXlExporter interface.

Example

Note

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

GeneralActions.cs

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

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

GeneralActions.vb

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

' 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

Related GitHub Examples

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

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

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

// Create an exporter instance.
IXlExporter exporter = XlExport.CreateExporter(documentFormat);
// Create a new document and begin to write it to the specified stream.

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

// Create an exporter instance.
IXlExporter exporter = XlExport.CreateExporter(documentFormat);
// Create a new document and begin to write it to the specified stream.

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L141

MemoryStream CreateBIFF8DataStream() {
    IXlExporter exporter = XlExport.CreateExporter(XlDocumentFormat.Xls);
    MemoryStream dataStream = new MemoryStream();

VB.NET

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

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

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

' Create an exporter instance.
Dim exporter As IXlExporter = XlExport.CreateExporter(documentFormat)
' Create a new document and begin to write it to the specified stream.

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

' Create an exporter instance.
Dim exporter As IXlExporter = XlExport.CreateExporter(documentFormat)
' Create a new document and begin to write it to the specified stream.

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L132

Private Function CreateBIFF8DataStream() As MemoryStream
    Dim exporter As IXlExporter = XlExport.CreateExporter(XlDocumentFormat.Xls)
    Dim dataStream As MemoryStream = New MemoryStream()