Skip to main content
Row

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

Workbook.ExportToPdfAsync(Stream, PdfExportOptions, String[]) Method

Asynchronously exports specific worksheets to the specified file path in PDF format using the specified options.

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.2.dll

NuGet Package: DevExpress.Document.Processor

#Declaration

public Task ExportToPdfAsync(
    Stream stream,
    PdfExportOptions options,
    params string[] sheetNames
)

#Parameters

Name Type Description
stream Stream

A Stream object to which the created PDF file should be sent.

options PdfExportOptions

A PdfExportOptions object specifying export settings.

sheetNames String[]

An array of string values that are names of the worksheets to be exported.

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

See Also