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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToPdf(Stream, PdfExportOptions) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

office-file-api-in-web-api-app/CS/BusinessObjects/Helpers.cs#L203

PdfExportOptions pdfExportOptions = SharedHelper.GetOptions(format);
workbook.ExportToPdf(resultStream, pdfExportOptions);

Implements

ExportToPdf(Stream, PdfExportOptions)