Workbook.ExportToPdf(Stream) Method

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

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void ExportToPdf(
    Stream stream
)

VB.NET

Public Sub ExportToPdf(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the created PDF file should be sent.

Remarks

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.

Example

This example demonstrates how to save a workbook in PDF format using the Workbook.ExportToPdf method.

View Example

ExportActions.cs

using (FileStream pdfFileStream = new FileStream("Documents\\Document_PDF.pdf", FileMode.Create))
{
    workbook.ExportToPdf(pdfFileStream);
}

ExportActions.vb

Using pdfFileStream As New FileStream("Documents\Document_PDF.pdf", FileMode.Create)
    workbook.ExportToPdf(pdfFileStream)
End Using

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToPdf(Stream) 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#

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/ExportActions.cs#L25

{
    workbook.ExportToPdf(pdfFileStream);
}

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/ExportActions.vb#L20

Using pdfFileStream As FileStream = New FileStream("Documents\Document_PDF.pdf", FileMode.Create)
    workbook.ExportToPdf(pdfFileStream)
End Using

Implements

ExportToPdf(Stream)