RichEditDocumentServerExtensions.ExportToPdfAsync(RichEditDocumentServer, Stream, PdfExportOptions) Method
Asynchronously exports the document to the specified stream with the specified options in the PDF format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v23.1.dll
NuGet Package: DevExpress.Document.Processor
Declaration
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. |
Returns
Type | Description |
---|---|
Task | An asynchronous export operation. |
Remarks
Important
The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v23.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 code sample below asynchronously exports a document to the PDF format:
private async void ConvertDocx2Pdf()
{
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
try
{
await wordProcessor.LoadDocumentAsync("Document.docx");
PdfExportOptions exportOptions = new PdfExportOptions();
exportOptions.ConvertImagesToJpeg = false;
exportOptions.DocumentOptions.Application = "Office File API";
await wordProcessor.ExportToPdfAsync(new FileStream("Documents\\Result.pdf",
FileMode.Create, FileAccess.ReadWrite), exportOptions);
}
catch (OperationCanceledException)
{
// Your code to handle cancellation
}
}
}