XtraReport.ExportToXlsx(String, XlsxExportOptions) Method

Exports a report to the specified stream in XLSX format using the specified XLS-specific options.This method exports data in WYSIWYG mode. Certain controls (e.g., a GridControl) can be exported to XLS(XLSX) format in a faster data-aware export mode, optimized for subsequent analysis of data in MS Excel. To learn how to employ data-aware export, see Export to XLS and XLSX Formats.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public void ExportToXlsx(
    string path,
    XlsxExportOptions options
)

VB.NET

Public Sub ExportToXlsx(
    path As String,
    options As XlsxExportOptions
)

Parameters

Name	Type	Description
path	String	A String which specifies the file name (including the full path) for the created XLSX file.
options	XlsxExportOptions	A XlsxExportOptions object which specifies the XLSX export options to be applied when a report is exported.

Remarks

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

Use this method to export a report in XLSX format using its current XLSX-specific export options, e.g. XlExportOptionsBase.ShowGridLines, XlExportOptionsBase.SheetName, etc. For a list of these options, and more information on using the ExportToXlsx method, refer to Export to XLSX.

Note that in this instance, the current report export options, represented by the XlsxExportOptions object returned by the ExportOptions.Xlsx property of a report’s XtraReport.ExportOptions, are ignored.

If you want to use the current export options of a report, you should call the overloaded XtraReport.ExportToXlsx method without the options parameter.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToXlsx(String, XlsxExportOptions) 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#

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/CS/WindowsFormsApplication1/Form1.cs#L34

report2.CreateDocument(false);
report.ExportToXlsx("test1.xlsx", new DevExpress.XtraPrinting.XlsxExportOptions() { SheetName = "report1" });
report2.ExportToXlsx("test2.xlsx", new DevExpress.XtraPrinting.XlsxExportOptions() { SheetName = "report2" });

VB.NET

Reporting_how-to-export-reports-to-different-sheets-in-an-xlsx-file-by-using-spreadsheet-e4892/VB/WindowsFormsApplication1/Form1.vb#L36

report2.CreateDocument(False)
report.ExportToXlsx("test1.xlsx", New DevExpress.XtraPrinting.XlsxExportOptions() With {.SheetName = "report1"})
report2.ExportToXlsx("test2.xlsx", New DevExpress.XtraPrinting.XlsxExportOptions() With {.SheetName = "report2"})