CachedReportSource.CreateDocumentAsync() Method

Creates a document from the report specified by the CachedReportSourceBase.Report property, so it can be displayed, printed and exported. Runs document generation in an individual task asynchronously.

Namespace: DevExpress.XtraPrinting.Caching

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public override Task CreateDocumentAsync()

VB.NET

Public Overrides Function CreateDocumentAsync As Task

Returns

Type	Description
Task	The task where document generation is performed.

Remarks

To display a report, a Print Preview (Document Viewer) generates a report document internally. However, you may need to obtain a report document without viewing it in a Print Preview, for instance, to merge reports, export or print them in code. In this instance, use the CreateDocumentAsync method to generate a report document manually.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraPrinting.Caching;
// ...
private void button_Click(object sender, EventArgs e) {
    var storage = new MemoryDocumentStorage();
    var report = new MyReport();
    var cachedReportSource = new CachedReportSource(report, storage);
    cachedReportSource.CreateDocumentAsync();
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraPrinting.Caching
' ...
Private Sub button_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim storage = New MemoryDocumentStorage()
    Dim report = New MyReport()
    Dim cachedReportSource = New CachedReportSource(report, storage)
    cachedReportSource.CreateDocumentAsync()
End Sub

This method returns the Task object, since the method performs document generation asynchronously. Use the Task object’s members to learn about the current document generation status. For instance, use the Wait() method to wait for the task’s completion before starting another document generation task. Simultaneous document generation raises the InvalidOperationException exception.

To restart a document generation, call the CachedReportSourceBase.StopPageBuilding method and wait until the task where this method operates completes. Then, call the CreateDocumentAsync method again.

You can access the generated document using the members of the object provided by the PrintingSystemBase.Document property of the CachedReportSource‘s CachedReportSourceBase.PrintingSystem.

If a report contains parameters and the XtraReport.RequestParameters property is set to true, reference the DevExpress.XtraPrinting.v24.1.dll assembly in your project and assign a ReportPrintTool to the report before calling the CreateDocumentAsync method.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraPrinting.Caching;
// ...
private void button1_Click(object sender, EventArgs e) {
    var storage = new MemoryDocumentStorage(); 
    var report = new MyReport(); 
    ReportPrintTool tool = new ReportPrintTool(report);
    var cachedReportSource = new CachedReportSource(report, storage); 
    cachedReportSource.CreateDocument();
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraPrinting.Caching
' ...
Private Sub button1_Click(sender As Object, e As EventArgs)
    Dim storage = New MemoryDocumentStorage()
    Dim report = New MyReport()
    Dim tool As New ReportPrintTool(report)
    Dim cachedReportSource = New CachedReportSource(report, storage)
    cachedReportSource.CreateDocument()
End Sub

The code above invokes the dialog requesting the report parameters’ values and then generates a document according to the specified parameter values.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateDocumentAsync() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-wpf-use-private-custom-font-distributed-with-application/CS/PrivateFontDemo/MainWindow.xaml.cs#L32

    preview.DocumentSource = cachedReportSource;
    cachedReportSource.CreateDocumentAsync();
}

VB.NET

reporting-wpf-use-private-custom-font-distributed-with-application/VB/PrivateFontDemo/MainWindow.xaml.vb#L32

    Me.preview.DocumentSource = cachedReportSource
    cachedReportSource.CreateDocumentAsync()
End Sub