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

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

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

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

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

<ExtensionAttribute>
Public Shared Function ExportToPdfAsync(
    self As RichEditDocumentServer,
    fileName As String,
    pdfExportOptions As PdfExportOptions,
    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.

| | 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.v25.2.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 code sample below asynchronously exports a document to the PDF format:

C#
VB.NET

csharp

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("Result.pdf", exportOptions, source.Token);
          }
          catch (OperationCanceledException)
          {
              // Your code to handle cancellation
          }
      }
  }
}

Private Async Sub ConvertDocx2PdfWithCancellation()
    Using source As CancellationTokenSource = New CancellationTokenSource(10000)

      Using wordProcessor As RichEditDocumentServer = New RichEditDocumentServer()

          Try
          Await wordProcessor.LoadDocumentAsync("Document.docx", source.Token)

          Dim exportOptions As New PdfExportOptions()
          exportOptions.ConvertImagesToJpeg = False
          exportOptions.DocumentOptions.Application = "Office File API"

          Await wordProcessor.ExportToPdfAsync("Result.pdf", exportOptions, source.Token)
          Catch __unusedOperationCanceledException1__ As OperationCanceledException
          ' Your code to handle cancellation
          End Try
      End Using
    End Using
End Sub