Workbook.ExportToPdfAsync(Stream, PdfExportOptions, IEnumerable<String>, CancellationToken) Method

Defines export options and asynchronously exports the specified sheets to the 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.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task ExportToPdfAsync(
    Stream stream,
    PdfExportOptions options,
    IEnumerable<string> sheetNames,
    CancellationToken cancellationToken
)

VB.NET

Public Function ExportToPdfAsync(
    stream As Stream,
    options As PdfExportOptions,
    sheetNames As IEnumerable(Of String),
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
stream	Stream	Specifies the output stream.
options	PdfExportOptions	Specifies export options.
sheetNames	IEnumerable<String>	Lists the names of the sheets to be saved in PDF format.
cancellationToken	CancellationToken	An object used to trace the requests to cancel the operation.

Returns

Type	Description
Task	An object that represents the asynchronous export operation.

Remarks

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).

Calculate Formulas Before Export

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.

Example

The following code snippet asynchronously loads the specified XLSX document and exports its Sheet1 and Sheet2 worksheets as a PDF file with the specified settings:

C#

private async void ExportToPdf(object sender, RoutedEventArgs e) {
    PdfExportOptions options = new PdfExportOptions();
    options.DocumentOptions.Author = "John Doe";
    options.DocumentOptions.Title = "Breakeven Analysis";
    options.ImageQuality = PdfJpegImageQuality.Medium;
    options.ExportBookmarks = false;

    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, options, new List<string>() { "Sheet1", "Sheet2" }, source.Token);
                }
            }
            catch (OperationCanceledException) {
                // Your code to handle cancellation.
            }
        }
    }
}

VB.NET

Private Async Sub ExportToPdf(sender As Object, e As RoutedEventArgs)
    Dim options As New PdfExportOptions()
    options.DocumentOptions.Author = "John Doe"
    options.DocumentOptions.Title = "Breakeven Analysis"
    options.ImageQuality = PdfJpegImageQuality.Medium
    options.ExportBookmarks = False

    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, options, New List(Of String) From {"Sheet1", "Sheet2"}, source.Token)
                End Using

            Catch ex As OperationCanceledException
                ' Your code to handle cancellation.
            End Try
        End Using
    End Using
End Sub