Workbook.ExportToPdfAsync(String, CancellationToken) Method
Asynchronously exports the workbook to the specified file path in PDF format.
You need a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
fileName | String | A String value which specifies the file name (including the full path) for the created PDF file. |
cancellationToken | CancellationToken | A CancellationToken object used to trace the requests to cancel an operation. |
Returns
Type | Description |
---|---|
Task | An Task object representing an asynchronous export operation. |
Remarks
Important
Take into account the following when you call this method:
The events fired by this method’s call may occur in a different thread than the target operation.
The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the
await
operator.
The code example below shows how to asynchronously convert an XLSX file to PDF format:
private async void ConvertXlsx2PdfWithCancellation()
{
using (CancellationTokenSource source = new CancellationTokenSource(10000))
{
using (Workbook workbook = new Workbook())
{
try
{
await workbook.LoadDocumentAsync("Document.xlsx", source.Token);
await workbook.ExportToPdfAsync("Result.pdf", source.Token);
}
catch (OperationCanceledException)
{
// Your code to handle cancellation.
}
}
}
}