Workbook.ExportToPdfAsync(String, PdfExportOptions, 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

C#

public Task ExportToPdfAsync(
    string fileName,
    PdfExportOptions options,
    CancellationToken cancellationToken
)

VB.NET

Public Function ExportToPdfAsync(
    fileName As String,
    options As PdfExportOptions,
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
fileName	String	A String value which specifies the file name (including the full path) for the created PDF file.
options	PdfExportOptions	A PdfExportOptions object specifying export settings.
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.