XtraReport.ExportToPdf(Stream, PdfExportOptions) Method

Exports a report to the specified stream in PDF using the specified PDF-specific options.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

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 which specifies the PDF export options to be applied when a report is exported.

Remarks

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

Use this method to export a report in PDF using the specified PDF export options (like PdfExportOptions.ImageQuality, PdfExportOptions.NeverEmbeddedFonts and others.) Note that in this instance the current report export options, which are represented by the PdfExportOptions object returned by the ExportOptions.Pdf property of a report’s XtraReport.ExportOptions, are ignored.

If you want to use the current export options of a report, you should call the overloaded XtraReport.ExportToPdf method without the options parameter.

Note

For more information on using the ExportToPdf method, and limitations on export to PDF, please refer to the Export to PDF document.

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#

reporting-print-export-report-without-showing-a-preview/CS/T569785/Controllers/HomeController.cs#L61

using (MemoryStream ms = new MemoryStream()) {
    report.ExportToPdf(ms, new PdfExportOptions() { ShowPrintDialogOnOpen = true });
    return ExportDocument(ms.ToArray(), "pdf", "Report.pdf", true);

VB.NET

reporting-print-export-report-without-showing-a-preview/VB/T569785/Controllers/HomeController.vb#L54

Using ms As New MemoryStream()
    report.ExportToPdf(ms, New PdfExportOptions() With {.ShowPrintDialogOnOpen = True})
    Return ExportDocument(ms.ToArray(), "pdf", "Report.pdf", True)