XtraReport.ExportToXlsx(String, XlsxExportOptions) Method

Exports a report to the specified file in XLSX format. This method exports data in WYSIWYG mode.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public void ExportToXlsx(
    string path,
    XlsxExportOptions options = null
)

VB.NET

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

Parameters

Name	Type	Description
path	String	A String that is the full path to a file.

Optional Parameters

Name	Type	Default	Description
options	XlsxExportOptions	null	A XlsxExportOptions object that specifies the XLSX export options. You can omit this parameter to use the current report export options.

Remarks

Note

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a XLSX file with the specified XLSX export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report’s XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Xlsx property provides access to the XlsxExportOptions object that contains the XLSX export options.

Important

This method overwrites files with the same name without confirmation.

Use the ExportToXlsxAsync(String, XlsxExportOptions, CancellationToken) method instead of ExportToXlsx to export a report asynchronously in a separate task.

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"})