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

Asynchronously exports the specified sheets to a stream in PDF format. Allows you to specify export options, implement progress notifications, and cancel the operation.

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.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

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

VB.NET

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

Parameters

Name	Type	Description
stream	Stream	Specifies the output stream.
options	PdfExportOptions	Defines export options.
sheetNames	IEnumerable<String>	Lists the names of the sheets to save as PDF.
cancellationToken	CancellationToken	A cancellation token that indicates whether to cancel the operation.
progress	IProgress<Int32>	An object used to report the task progress in percentage. Use a Progress<T> class instance to report progress.

Returns

Type	Description
Task	An object that defines 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.