XtraReport.ExportToXlsxAsync(Stream, XlsxExportOptions, CancellationToken) Method
Asynchronously exports a report to the specified stream in XLSX format.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v24.1.dll
NuGet Package: DevExpress.Reporting.Core
Declaration
public Task ExportToXlsxAsync(
Stream stream,
XlsxExportOptions options = null,
CancellationToken token = default(CancellationToken)
)
Parameters
Name | Type | Description |
---|---|---|
stream | Stream | A Stream for output data. |
Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
options | XlsxExportOptions | null | The XLSX export options. You can omit this parameter to use the current report export options. |
token | CancellationToken | null | A cancellation token that the task observes. |
Returns
Type | Description |
---|---|
Task | A task that exports the report. |
Remarks
This method is equivalent to the ExportToXlsx(Stream, XlsxExportOptions) method but does not lock other actions performed concurrently. For instance, the user interface remains operational while the application exports a report.
Call ExportToXlsxAsync 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 ExportToXlsxAsync method call. Call the CancellationTokenSource.Cancel method to stop the task.
Example
The code sample below exports a report to XLSX 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;
// ...
using System.IO;
// ...
// 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 ExportReportToXlsxStreamAsync()
{
// Create a simple report.
XtraReport report = new XtraReport()
{
Name = "SimpleReport",
Bands = {
new DetailBand() {
Controls = {
new XRLabel() {
Text = "Simple Report"
}
}
}
}
};
// Create the export file in the user's Downloads folder.
FileStream stream = File.Open(
Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) + @"\Downloads\" + report.Name + ".xlsx",
FileMode.Create);
// Export the report to the created file.
await report.ExportToXlsxAsync(
stream,
null,
cancellationTokenSource.Token);
}