XtraReport.ExportToDocxAsync(String, DocxExportOptions, CancellationToken) Method

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

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public Task ExportToDocxAsync(
    string path,
    DocxExportOptions options = null,
    CancellationToken token = default(CancellationToken)
)

VB.NET

Public Function ExportToDocxAsync(
    path As String,
    options As DocxExportOptions = Nothing,
    token As CancellationToken = Nothing
) As Task

Parameters

Name	Type	Description
path	String	The path to the exported DOCX file.

Optional Parameters

Name	Type	Default	Description
options	DocxExportOptions	null	The DOCX 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 ExportToDocx(String, DocxExportOptions) method but does not lock other actions performed concurrently. For instance, the user interface remains operational while the application exports a report.

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

Example

The code sample below exports a report to DOCX asynchronously. A CancellationTokenSource class instance is used to allow users to interrupt the report export if it takes too long.

C#

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 ExportReportToDocxStreamAsync()
{
    // 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 + ".docx",
        FileMode.Create);
    // Export the report to the created file.
    await report.ExportToDocxAsync(
        stream,
        null,
        cancellationTokenSource.Token);
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports System.Threading
' ...
Imports System.IO
' ...
' 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 ExportReportToDocxStreamAsync()
    ' 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)
    ' Create the export file in the user's Downloads folder.
    Dim stream As FileStream = File.Open(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) _
                                         & "\Downloads\" & report.Name & ".docx", FileMode.Create)
    ' Export the report to the created file.
    Await report.ExportToDocxAsync(stream, Nothing, cancellationTokenSource.Token)
End Sub