Workbook.ExportToPdf(Stream, PdfExportOptions) Method

Exports the workbook to the specified stream 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.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void ExportToPdf(
    Stream stream,
    PdfExportOptions options
)

VB.NET

Public Sub ExportToPdf(
    stream As Stream,
    options As PdfExportOptions
)

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.

Remarks

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

C#

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;

using (FileStream pdfFileStream = new FileStream("Exported_Document.pdf", FileMode.Create)) {
    workbook.ExportToPdf(pdfFileStream, options);
}

VB.NET

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

Using pdfFileStream As New FileStream("Exported_Document.pdf", FileMode.Create)
    workbook.ExportToPdf(pdfFileStream, options)
End Using

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(Stream, PdfExportOptions)