RichEditDocumentServerExtensions.ExportToPdfAsync(RichEditDocumentServer, Stream, CancellationToken) Method
Asynchronously exports the document to the specified stream in the PDF format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
#Declaration
public static Task ExportToPdfAsync(
this RichEditDocumentServer self,
Stream stream,
CancellationToken cancellationToken
)
#Parameters
Name | Type | Description |
---|---|---|
self | Rich |
The current Rich |
stream | Stream | A stream to which the document is exported. |
cancellation |
Cancellation |
A Cancellation |
#Returns
Type | Description |
---|---|
Task | An asynchronous export operation. |
#Remarks
Important
The Rich
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:
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);
await wordProcessor.ExportToPdfAsync(new FileStream("Documents\SavedDocument.pdf", FileMode.Create, FileAccess.ReadWrite), source.Token);
}
catch (OperationCanceledException)
{
// Your code to handle cancellation
}
}
}
}