Skip to main content
All docs
V24.1

RichEditDocumentServerExtensions.ExportToPdfAsync(RichEditDocumentServer, String, CancellationToken) Method

Asynchronously exports the document to the specified file in the PDF format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

public static Task ExportToPdfAsync(
    this RichEditDocumentServer self,
    string fileName,
    CancellationToken cancellationToken
)

Parameters

Name Type Description
self RichEditDocumentServer

The current RichEditDocumentServer instance.

fileName String

The file name (including the full path) for the newly created PDF file.

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.v24.1.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need a 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 on application startup.

Important

Take into account the following when you call this method:

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

  • The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the await operator).

The following code sample converts a DOCX file to PDF format asynchronously and cancels the operation if it takes longer than 10 seconds:

using DevExpress.XtraRichEdit;
using System;
using System.Threading;
using System.Threading.Tasks;
//...

private async void ConvertDocx2PdfWithCancellation()
{
    // Specify the cancellation token.
    using (CancellationTokenSource source = new CancellationTokenSource(10000))
    {
        using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
        {
            try
            {
                // Asynchronously load the DOCX file.
                await wordProcessor.LoadDocumentAsync("Document.docx", source.Token);
                // Asynchronously convert the DOCX file to PDF.
                await wordProcessor.ExportToPdfAsync("result.pdf", source.Token);
            }
            catch (OperationCanceledException)
            {
                Console.WriteLine("Cancelled by timeout.");
            }
        }
    }
}
See Also