RichEditDocumentServerExtensions.ExportToPdfAsync(RichEditDocumentServer, String, CancellationToken) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v25.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

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

VB.NET

<ExtensionAttribute>
Public Shared Function ExportToPdfAsync(
    self As RichEditDocumentServer,
    fileName As String,
    cancellationToken As CancellationToken
) As Task

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.v25.1.dll assembly and DevExpress.Document.Processor NuGet package. Add this assembly or package 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.

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:

C#

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.");
            }
        }
    }
}

VB.NET

Imports DevExpress.XtraRichEdit
Imports System
Imports System.Threading
Imports System.Threading.Tasks
' ...

Private Async Sub ConvertDocx2PdfWithCancellation()
    ' Specify the cancellation token.
    Using source As New CancellationTokenSource(10000)
        Using wordProcessor As 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 e1 As OperationCanceledException
                Console.WriteLine("Cancelled by timeout.")
            End Try
        End Using
    End Using
End Sub