Skip to main content
A newer version of this page is available. .

PrintControl.UseAsyncDocumentCreation Property

Gets or sets whether the DocumentViewer should create a report document asynchronously in a separate task.

Namespace: DevExpress.XtraPrinting.Control

Assembly: DevExpress.XtraPrinting.v21.2.dll

NuGet Packages: DevExpress.Win.Design, DevExpress.Win.Printing

Declaration

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean UseAsyncDocumentCreation { get; set; }

Property Value

Type Default Description
DefaultBoolean Default

True, to create a report document asynchronously in a separate task; otherwise, False. Default specifies the same behavior as False.

Available values:

Name Description
True

true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.

False

false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.

Default

The default behavior determined by the control’s logic.

Remarks

Set this property before you assign an XtraReport class instance to the DocumentViewer. Asynchronous document creation does not lock other actions performed in the application. For instance, the user interface remains responsive.

Example

The code sample below creates a DocumentViewer instance, specifies that this instance should create documents asynchronously, and assigns an XtraReport to this instance for preview.

using System;
using System.Windows.Forms;
using System.Threading;
using DevExpress.Utils;
using DevExpress.XtraReports.UI;
using DevExpress.XtraPrinting.Preview;
// ...
DocumentViewer viewer = new DocumentViewer();
viewer.UseAsyncDocumentCreation = DefaultBoolean.True;
viewer.DocumentSource = report;
See Also