Back to Devexpress

XtraReport.ExportToXlsx(String, XlsxExportOptions) Method

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xtrareport-dot-exporttoxlsx-x28-system-dot-string-devexpress-dot-xtraprinting-dot-xlsxexportoptions-x29.md

latest5.7 KB
Original Source

XtraReport.ExportToXlsx(String, XlsxExportOptions) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

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

Namespace : DevExpress.XtraReports.UI

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

csharp
public void ExportToXlsx(
    string path,
    XlsxExportOptions options = null
)
vb
Public Sub ExportToXlsx(
    path As String,
    options As XlsxExportOptions = Nothing
)

Parameters

NameTypeDescription
pathString

A String that is the full path to a file.

|

Optional Parameters

NameTypeDefaultDescription
optionsXlsxExportOptionsnull

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 file in XLSX format with the specified XLSX export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Xlsx notation.

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.

Review the following help topic for more information and code examples: Export to XLSX.

The following code snippets (auto-collected from DevExpress Examples) contain references 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.

reporting-winforms-export-reports-to-diff-sheets-in-xlsx-file-with-spreadsheet-document-api/CS/WindowsFormsApplication1/Form1.cs#L34

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

reporting-winforms-export-report-to-xlsx-format/CS/Form1.cs#L42

csharp
// Export the report.
report.ExportToXlsx(xlsxExportFileName, xlsxExportOptions);
System.Diagnostics.Process.Start(xlsxExportFileName);

reporting-winforms-export-reports-to-diff-sheets-in-xlsx-file-with-spreadsheet-document-api/VB/WindowsFormsApplication1/Form1.vb#L33

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

reporting-winforms-export-report-to-xlsx-format/VB/Form1.vb#L23

vb
' Export the report.
report.ExportToXlsx(xlsxExportFileName, xlsxExportOptions)
System.Diagnostics.Process.Start(xlsxExportFileName)

See Also

Export Reports

Export to XLSX

XtraReport Class

XtraReport Members

DevExpress.XtraReports.UI Namespace