Skip to main content
All docs
V25.1
  • 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.v25.1.dll

    NuGet Package: 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 Return Value
    True

    The value is true.

    0

    False

    The value is false.

    1

    Default

    The value is specified by a global option or a higher-level object.

    2

    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