officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-exporttopdfasync-x28-system-dot-io-dot-stream-system-dot-threading-dot-cancellationtoken-x29.md
Asynchronously exports the workbook to the specified stream in PDF format.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Docs.v25.2.dll
NuGet Package : DevExpress.Document.Processor
public Task ExportToPdfAsync(
Stream stream,
CancellationToken cancellationToken
)
Public Function ExportToPdfAsync(
stream As Stream,
cancellationToken As CancellationToken
) As Task
| Name | Type | Description |
|---|---|---|
| stream | Stream |
A Stream object to which the created PDF file should be sent.
| | cancellationToken | CancellationToken |
A CancellationToken object used to trace the requests to cancel an operation.
|
| Type | Description |
|---|---|
| Task |
An Task object representing an asynchronous export operation.
|
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 default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not recalculate formulas before it generates a PDF document. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook before you export it to PDF.
The following code snippet asynchronously loads the specified XLSX document and exports it as a PDF file with the specified settings:
private async void ExportToPdf(object sender, RoutedEventArgs e) {
using (CancellationTokenSource source = new CancellationTokenSource(10000)) {
using (Workbook workbook = new Workbook()) {
try {
await workbook.LoadDocumentAsync("BreakevenAnalysis.xlsx");
using (FileStream pdfFileStream = new FileStream("Exported_Document.pdf", FileMode.Create)) {
await workbook.ExportToPdfAsync(pdfFileStream, source.Token);
}
}
catch (OperationCanceledException) {
// Your code to handle cancellation.
}
}
}
}
Private Async Sub ExportToPdf(ByVal sender As Object, ByVal e As RoutedEventArgs)
Using source As New CancellationTokenSource(10000)
Using workbook As New Workbook()
Try
Await workbook.LoadDocumentAsync("BreakevenAnalysis.xlsx")
Using pdfFileStream As New FileStream("Exported_Document.pdf", FileMode.Create)
Await workbook.ExportToPdfAsync(pdfFileStream, source.Token)
End Using
Catch ex As OperationCanceledException
' Your code to handle cancellation.
End Try
End Using
End Using
End Sub
See Also