xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xtrareport-dot-exporttoxlsasync-x28-system-dot-string-devexpress-dot-xtraprinting-dot-xlsexportoptions-system-dot-threading-dot-cancellationtoken-x29.md
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.
Asynchronously exports a report to the specified file in XLS format.
Namespace : DevExpress.XtraReports.UI
Assembly : DevExpress.XtraReports.v25.2.dll
NuGet Package : DevExpress.Reporting.Core
public Task ExportToXlsAsync(
string path,
XlsExportOptions options = null,
CancellationToken token = default(CancellationToken)
)
Public Function ExportToXlsAsync(
path As String,
options As XlsExportOptions = Nothing,
token As CancellationToken = Nothing
) As Task
| Name | Type | Description |
|---|---|---|
| path | String |
The path to the exported XLS file.
|
| Name | Type | Default | Description |
|---|---|---|---|
| options | XlsExportOptions | null |
The XLS export options. You can omit this parameter to use the current report export options.
| | token | CancellationToken | null |
A cancellation token that the task observes.
|
| Type | Description |
|---|---|
| Task |
A task that exports the report.
|
This method is equivalent to the ExportToXls(String, XlsExportOptions) method but does not lock other actions performed concurrently. For instance, the user interface remains operational while the application exports a report.
Call ExportToXlsAsync from an async method. Prefix the call with the await operator, as shown in the code sample below.
The optional CancellationToken parameter provides a way to send the cancellation signal to the task. The task monitors the token and stops when it receives the signal. Create a CancellationTokenSource class instance and pass its Token property to the ExportToXlsAsync method call. Call the CancellationTokenSource.Cancel method to stop the task.
The code sample below exports a report to XLS asynchronously. A CancellationTokenSource class instance is used to allow users to interrupt the report export if it takes too long.
using DevExpress.XtraReports.UI;
using System;
using System.Threading;
// ...
// Use cancellationTokenSource to allow users to stop the document creation process.
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
// ...
// The cancelButton_Click event handler uses cancellationTokenSource to stop the document creation process.
private void cancelButton_Click(object sender, EventArgs e)
{
cancellationTokenSource.Cancel();
}
// ...
async public void ExportReportToXlsFileAsync()
{
// Create a simple report.
XtraReport report = new XtraReport()
{
Name = "SimpleReport",
Bands = {
new DetailBand() {
Controls = {
new XRLabel() {
Text = "Simple Report"
}
}
}
}
};
// Export the report. The export file is added to the user's Downloads folder.
await report.ExportToXlsAsync(
Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) + @"\Downloads\" + report.Name + ".xls",
null,
cancellationTokenSource.Token);
}
' Use cancellationTokenSource to allow users to stop the document creation process.
Private cancellationTokenSource As New CancellationTokenSource()
' ...
' The cancelButton_Click event handler uses cancellationTokenSource to stop the document creation process.
Private Sub cancelButton_Click(ByVal sender As Object, ByVal e As EventArgs)
cancellationTokenSource.Cancel()
End Sub
' ...
Public Async Sub ExportReportToXlsFileAsync()
' Create a simple report.
Dim report = New XtraReport() With {.Name = "SimpleReport"}
Dim band = New DetailBand()
Dim control = New XRLabel() With {.Text = "Simple Report"}
band.Controls.Add(control)
report.Bands.Add(band)
Await report.ExportToXlsAsync(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) _
& "\Downloads\" & report.Name & ".xls", Nothing, cancellationTokenSource.Token)
End Sub
See Also