IXlDocument Interface

Represents an interface that exposes the specific functionality of a workbook.

Namespace: DevExpress.Export.Xl

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

Declaration

C#

public interface IXlDocument :
    IDisposable

VB.NET

Public Interface IXlDocument
    Inherits IDisposable

Related API Members

The following members accept/return IXlDocument objects:

• IXlExporter.CreateDocument(Stream)
• IXlExporter.CreateDocument(Stream, EncryptionOptions)

Remarks

An object that exposes the IXlDocument interface is the main spreadsheet document. To create it, call the IXlExporter.CreateDocument method. To add a worksheet to the created workbook, use the IXlDocument.CreateSheet 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 IXlDocument 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#L22

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

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

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

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

how-to-use-the-excel-export-api-to-generate-an-invoice-t252983/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.

how-to-use-the-excel-export-api-to-perform-a-sales-analysis-t252486/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-t253492/VB/XLExportExamples/SpreadsheetActions/SparklineActions.vb#L21

' 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-t251723/VB/XLExportExample/Form1.vb#L110

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

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

how-to-use-the-excel-export-api-to-generate-an-invoice-t252983/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.

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

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