IXlExporter Interface

Represents an exporter used to create a spreadsheet document and export it to a stream.

Namespace: DevExpress.Export.Xl

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

Declaration

C#

public interface IXlExporter

VB.NET

Public Interface IXlExporter

Related API Members

The following members accept/return IXlExporter objects:

• XlExport.CreateExporter(XlDocumentFormat)
• XlExport.CreateExporter(XlDocumentFormat, IXlFormulaParser)

Remarks

To create an object that exposes the IXlExporter interface, use the XlExport.CreateExporter method.

To generate a new spreadsheet document and write it to a stream, call the IXlExporter.CreateDocument method.

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 IXlExporter interface.

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/FormulaActions.cs#L20

// Create an exporter instance.
IXlExporter exporter = XlExport.CreateExporter(documentFormat, new XlFormulaParser());
// Create a new document.

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

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

how-to-use-the-excel-export-api-to-generate-a-sales-report-t251810/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.

how-to-use-the-excel-export-api-to-generate-an-invoice-t252983/CS/XLExportExample/Form1.cs#L141

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

how-to-use-the-excel-export-api-to-perform-a-sales-analysis-t252486/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.

VB.NET

excel-export-api-examples-t253492/VB/XLExportExamples/SpreadsheetActions/SparklineActions.vb#L18

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

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

' Create an exporter with the specified formula parser.
Dim exporter As IXlExporter = XlExport.CreateExporter(documentFormat, New XlFormulaParser())
' Create a new document and begin to write it to the specified stream.

how-to-use-the-excel-export-api-to-generate-a-sales-report-t251810/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.

how-to-use-the-excel-export-api-to-generate-an-invoice-t252983/VB/XLExportExample/Form1.vb#L149

' Create an exporter with the specified formula parser.
Dim exporter As IXlExporter = XlExport.CreateExporter(documentFormat, New XlFormulaParser())
' Create a new document and begin to write it to the specified stream.

how-to-use-the-excel-export-api-to-perform-a-sales-analysis-t252486/VB/XLExportExample/Form1.vb#L113

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