Back to Devexpress

Workbook.ExportToPdf(String, PdfExportOptions, String[]) Method

officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-exporttopdf-x28-system-dot-string-devexpress-dot-xtraprinting-dot-pdfexportoptions-system-dot-string-x29.md

latest3.8 KB
Original Source

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

Defines export options and exports the specified sheets to the file in PDF format.

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

Declaration

csharp
public void ExportToPdf(
    string fileName,
    PdfExportOptions options,
    params string[] sheetNames
)
vb
Public Sub ExportToPdf(
    fileName As String,
    options As PdfExportOptions,
    ParamArray sheetNames As String()
)

Parameters

NameTypeDescription
fileNameString

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

| | options | PdfExportOptions |

Specifies export options.

| | sheetNames | String[] |

The names of the sheets to be saved in PDF format.

|

Remarks

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

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");
vb
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")

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

How to: Export a Workbook to PDF

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace