All docs
V20.2
21.1 (EAP/Beta)
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

RichEditDocumentServerExtensions.ExportToPdfAsync(RichEditDocumentServer, Stream, PdfExportOptions, CancellationToken) Method

Asynchronously exports the document to the specified stream with the specified options in PDF format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v20.2.dll

Declaration

public static Task ExportToPdfAsync(
    this RichEditDocumentServer self,
    Stream stream,
    PdfExportOptions pdfExportOptions,
    CancellationToken cancellationToken
)

Parameters

Name Type Description
self RichEditDocumentServer

The current RichEditDocumentServer instance.

stream Stream

A stream to which the document is exported.

pdfExportOptions PdfExportOptions

A PdfExportOptions instance that contains PDF export options.

cancellationToken CancellationToken

A CancellationToken object used to trace requests to cancel an operation.

Returns

Type Description
Task

An asynchronous export operation.

Remarks

IMPORTANT

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v20.2.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this library in production code.

For information on PDF Export features and limitations, refer to the following help topic: Export to PDF.

If an application is hosted on Microsoft Azure, set the AzureCompatibility.Enable property to true. Refer to the following KB Article for more information: How to resolve issues with unexpected output content of Printing, Reporting, RichEditDocumentServer, PDF libraries on Azure Web Site.

IMPORTANT

Take into account the following when you call this method:

  • The events fired by this method's call may occur in a different thread than the target operation.

  • The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the await operator.

The code sample below asynchronously exports a document to the PDF format:

private async void ConvertDocx2PdfWithCancellation()
{
  //10 second limit
  using (CancellationTokenSource source = new CancellationTokenSource(10000))
  {
    using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
      {
          try
          {
              await wordProcessor.LoadDocumentAsync("Document.docx", source.Token);

            PdfExportOptions exportOptions = new PdfExportOptions();
            exportOptions.ConvertImagesToJpeg = false;
            exportOptions.DocumentOptions.Application = "Office File API";

              await wordProcessor.ExportToPdfAsync(new FileStream("Documents\SavedDocument.pdf", FileMode.Create, FileAccess.ReadWrite), exportOptions, source.Token);
          }
          catch (OperationCanceledException)
          {
              // Your code to handle cancellation
          }
      }
  }
}
See Also