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

Defines export options and exports the specified sheets to the stream 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

csharp

public void ExportToPdf(
    Stream stream,
    PdfExportOptions options,
    params string[] sheetNames
)

Public Sub ExportToPdf(
    stream As Stream,
    options As PdfExportOptions,
    ParamArray sheetNames As String()
)

Parameters

Name	Type	Description
stream	Stream

Specifies the output stream.

| | 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:

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;

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

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, workbook.Worksheets(0).Name)
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.