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

Exports the workbook 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.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public void ExportToPdf(
    string fileName,
    PdfExportOptions options
)

Public Sub ExportToPdf(
    fileName As String,
    options As PdfExportOptions
)

Parameters

Name	Type	Description
fileName	String

A String which specifies the file name (including the full path) for the created PDF file.

| | options | PdfExportOptions |

A PdfExportOptions object specifying export settings.

Remarks

The following code snippet loads the specified XLSX document and exports it as a PDF file with the specified settings:

C#
VB.NET

csharp

Workbook workbook = new Workbook();
workbook.LoadDocument("BreakevenAnalysis.xlsx");

PdfExportOptions options = new PdfExportOptions();
options.DocumentOptions.Author = "John Doe";
options.DocumentOptions.Title = "Breakeven Analysis";
options.ImageQuality = PdfJpegImageQuality.Medium;
options.ExportBookmarks = false;

workbook.ExportToPdf("Exported_Document.pdf", options);

Dim workbook As New Workbook()
workbook.LoadDocument("BreakevenAnalysis.xlsx")

Dim options As New PdfExportOptions()
options.DocumentOptions.Author = "John Doe"
options.DocumentOptions.Title = "Breakeven Analysis"
options.ImageQuality = PdfJpegImageQuality.Medium
options.ExportBookmarks = False

workbook.ExportToPdf("Exported_Document.pdf", options)

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.

Implements

ExportToPdf(String, PdfExportOptions)