XtraReport.ExportToHtmlAsync(String, HtmlExportOptions, CancellationToken) Method

Asynchronously exports a report to the specified file in HTML format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v21.2.dll


public Task ExportToHtmlAsync(
    string path,
    HtmlExportOptions options = null,
    CancellationToken token = default(CancellationToken)


Name Type Description
path String

The path to the exported HTML file.

Optional Parameters

Name Type Default Description
options HtmlExportOptions


The HTML export options. You can omit this parameter to use the current report export options.

token CancellationToken


A cancellation token that the task observes.


Type Description

A task that exports the report.


This method is equivalent to the ExportToHtml(String, HtmlExportOptions) method but does not lock other actions performed concurrently. For instance, the user interface remains operational while the application exports a report.

Call ExportToHtmlAsync 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 ExportToHtmlAsync method call. Call the CancellationTokenSource.Cancel method to stop the task.


The code sample below exports a report to HTML 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)
// ...
async public void ExportReportToHtmlStreamAsync()
    // 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 + ".html",
    // Export the report to the created file.
    await report.ExportToHtmlAsync(
See Also