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

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Asynchronously exports the workbook to a file in PDF format. Allows you to specify export options and implement progress notifications.

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

csharp

public Task ExportToPdfAsync(
    string fileName,
    PdfExportOptions options,
    IProgress<int> progress
)

Public Function ExportToPdfAsync(
    fileName As String,
    options As PdfExportOptions,
    progress As IProgress(Of Integer)
) As Task

Parameters

Name	Type	Description
fileName	String

The file name (including the full path) for the output PDF file.

| | options | PdfExportOptions |

Defines export options.

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

Example: Report Progress of Workbook Operations

The following example asynchronously loads and exports a workbook to PDF. The console window displays the progress of each operation.

C#
VB.NET

csharp

using System;
using System.IO;
using System.Threading.Tasks;
using DevExpress.Spreadsheet;
using DevExpress.XtraPrinting;
// ...

static async Task Main(string[] args) {
    using (Workbook workbook = new Workbook())
    {
        Console.WriteLine("Loading a document...");
        using (FileStream docStream = new FileStream("Document.xlsx", FileMode.Open))
        {
            await workbook.LoadDocumentAsync(docStream,
                new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
        }
        Console.WriteLine("Exporting to PDF...");
        // Specify PDF export options.
        var pdfOptions = new PdfExportOptions() { 
            ConvertImagesToJpeg = true, 
            ImageQuality = PdfJpegImageQuality.Low 
        };
        await workbook.ExportToPdfAsync("Result.pdf", pdfOptions,
            new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
        Console.WriteLine("Done!");
    }
}

Imports System
Imports System.IO
Imports System.Threading.Tasks
Imports DevExpress.Spreadsheet
Imports DevExpress.XtraPrinting

Module Example
    Sub Main()
        MainAsync().Wait()
    End Sub
    Async Function MainAsync() As Task
        Using workbook As New Workbook()
            Console.WriteLine("Loading a document...")
            Using docStream As New FileStream("Document.xlsx", FileMode.Open)
                Await workbook.LoadDocumentAsync(docStream, 
                    New Progress(Of Integer)(Sub(progress) Console.WriteLine($"{progress}%")))
            End Using
            Console.WriteLine("Exporting to PDF...")
            ' Specify PDF export options.
            Dim pdfOptions As New PdfExportOptions() With {
                .ConvertImagesToJpeg = True,
                .ImageQuality = PdfJpegImageQuality.Low
            }
            Await workbook.ExportToPdfAsync("Result.pdf", pdfOptions, 
                New Progress(Of Integer)(Sub(progress) Console.WriteLine($"{progress}%")))
            Console.WriteLine("Done!")
        End Using
    End Function
End Module

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.