Skip to main content
All docs

XtraReport.PrintAsync(String, CancellationToken) Method

Asynchronously sends a report to the specified printer.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.1.dll

NuGet Package: DevExpress.Reporting.Core


public Task PrintAsync(
    string printerName = "",
    CancellationToken token = default(CancellationToken)

Optional Parameters

Name Type Default Description
printerName String String.Empty

The name of the printer that should print the report. An empty string specifies the system’s default printer.

token CancellationToken null

A cancellation token that the task observes.


Type Description

A task that sends the report to the printer.


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

Call the PrintAsync method with the await operator.

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


The code sample below prints a report asynchronously on the system’s default printer. A CancellationTokenSource class instance is used to allow users to interrupt the document printing process 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)
// ...
// Create a simple report.
XtraReport report = new XtraReport()
    Name = "SimpleReport",
    Bands = {
        new DetailBand() {
            Controls = {
                new XRLabel() {
                    Text = "Simple Report"
// Print the report.
await report.PrintAsync("", cancellationTokenSource.Token);
See Also