XtraReport.ExportToPdf(String) Method

Exports a report to the specified file path in PDF.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToPdf(
    string path
)

VB.NET

Public Sub ExportToPdf(
    path As String
)

Parameters

Name	Type	Description
path	String	A String which specifies the file name (including the full path) for the created PDF file.

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 to a PDF file using its current PDF-specific export options. These options are represented by the PdfExportOptions object returned by the ExportOptions.Pdf property of a report’s XtraReport.ExportOptions. This object provides the PdfExportOptions.ImageQuality, PdfExportOptions.NeverEmbeddedFonts and other properties which are intended to specify parameters of the resulting PDF file.

If you want to ignore current export options of a report, and use your specific settings when a report is exported to PDF, you should use the overloaded XtraReport.ExportToPdf method with the options parameter.

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

Note

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

Example

This example illustrates how to export a report to PDF using the XtraReport.ExportToPdf method with specific PdfExportOptions applied.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-export-a-report-to-pdf-format-e44.

Form1.vb

Imports DevExpress.XtraPrinting
Imports System
Imports System.Collections.Generic
Imports System.Windows.Forms
' ...

Namespace WindowsFormsApplication1
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
            ' A path to export a report.
            Dim reportPath As String = "c:\\Temp\Test.pdf"

            Using report As New XtraReport1()
                ' Specify PDF-specific export options.
                Dim pdfOptions As PdfExportOptions = report.ExportOptions.Pdf

                ' Specify the pages to be exported.
                pdfOptions.PageRange = "1, 3-5"

                ' Specify the quality of exported images.
                pdfOptions.ConvertImagesToJpeg = False
                pdfOptions.ImageQuality = PdfJpegImageQuality.Medium

                ' Specify the PDF/A-compatibility.
                pdfOptions.PdfACompatibility = PdfACompatibility.PdfA3b

                ' The following options are not compatible with PDF/A.
                ' The use of these options will result in errors on PDF validation.
                'pdfOptions.NeverEmbeddedFonts = "Tahoma;Courier New";
                'pdfOptions.ShowPrintDialogOnOpen = true;

                ' If required, you can specify the security and signature options. 
                'pdfOptions.PasswordSecurityOptions
                'pdfOptions.SignatureOptions

                ' If required, specify necessary metadata and attachments
                ' (e.g., to produce a ZUGFeRD-compatible PDF).
                'pdfOptions.AdditionalMetadata
                'pdfOptions.Attachments

                ' Specify the document options.
                pdfOptions.DocumentOptions.Application = "Test Application"
                pdfOptions.DocumentOptions.Author = "DX Documentation Team"
                pdfOptions.DocumentOptions.Keywords = "DevExpress, Reporting, PDF"
                pdfOptions.DocumentOptions.Producer = Environment.UserName.ToString()
                pdfOptions.DocumentOptions.Subject = "Document Subject"
                pdfOptions.DocumentOptions.Title = "Document Title"

                ' Checks the validity of PDF export options 
                ' and return a list of any detected inconsistencies.
                Dim result As IList(Of String) = pdfOptions.Validate()
                If result.Count > 0 Then
                    Console.WriteLine(String.Join(Environment.NewLine, result))
                Else
                    report.ExportToPdf(reportPath, pdfOptions)
                End If
            End Using

        End Sub

    End Class
End Namespace

Form1.cs

using DevExpress.XtraPrinting;
using System;
using System.Collections.Generic;
using System.Windows.Forms;
// ...

namespace WindowsFormsApplication1 {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e) {
            // A path to export a report.
            string reportPath = @"c:\\Temp\Test.pdf";

            using (XtraReport1 report = new XtraReport1()) {
                // Specify PDF-specific export options.
                PdfExportOptions pdfOptions = report.ExportOptions.Pdf;

                // Specify the pages to be exported.
                pdfOptions.PageRange = "1, 3-5";

                // Specify the quality of exported images.
                pdfOptions.ConvertImagesToJpeg = false;
                pdfOptions.ImageQuality = PdfJpegImageQuality.Medium;

                // Specify the PDF/A-compatibility.
                pdfOptions.PdfACompatibility = PdfACompatibility.PdfA3b;

                // The following options are not compatible with PDF/A.
                // The use of these options will result in errors on PDF validation.
                //pdfOptions.NeverEmbeddedFonts = "Tahoma;Courier New";
                //pdfOptions.ShowPrintDialogOnOpen = true;

                // If required, you can specify the security and signature options. 
                //pdfOptions.PasswordSecurityOptions
                //pdfOptions.SignatureOptions

                // If required, specify necessary metadata and attachments
                // (e.g., to produce a ZUGFeRD-compatible PDF).
                //pdfOptions.AdditionalMetadata
                //pdfOptions.Attachments

                // Specify the document options.
                pdfOptions.DocumentOptions.Application = "Test Application";
                pdfOptions.DocumentOptions.Author = "DX Documentation Team";
                pdfOptions.DocumentOptions.Keywords = "DevExpress, Reporting, PDF";
                pdfOptions.DocumentOptions.Producer = Environment.UserName.ToString();
                pdfOptions.DocumentOptions.Subject = "Document Subject";
                pdfOptions.DocumentOptions.Title = "Document Title";

                // Checks the validity of PDF export options 
                // and return a list of any detected inconsistencies.
                IList<string> result = pdfOptions.Validate();
                if (result.Count > 0)
                    Console.WriteLine(String.Join(Environment.NewLine, result));
                else
                    report.ExportToPdf(reportPath, pdfOptions);
            }

        }

    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToPdf(String) 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#

xaf-how-to-create-and-setup-an-xtrareport-report-for-exporting-to-a-stream-in-a-non-xaf/CS/ExportReportDemo/ExportXafReport/Program.cs#L29

        reportDataSourceHelper.SetupBeforePrint(report);
        report.ExportToPdf("test.pdf");
}

Reporting_report-building-basics-e925/CS/Form1.cs#L39

    // Export the report to PDF.
    report.ExportToPdf("report.pdf");
}

Reporting_how-to-export-report-groups-to-different-files-e4006/CS/Form1.cs#L26

    string name = Guid.NewGuid().ToString();
    newReport.ExportToPdf(name + ".pdf");
}

Reporting_how-to-list-all-reports-available-in-an-application-t110546/CS/WindowsFormsApplication1/Form1.cs#L35

    XtraReport report = Activator.CreateInstance(reportType) as XtraReport;
    report.ExportToPdf(folderBrowserDialog1.SelectedPath + "\\" + reportType.Name + ".pdf");
}

VB.NET

xaf-how-to-create-and-setup-an-xtrareport-report-for-exporting-to-a-stream-in-a-non-xaf/VB/ExportReportDemoEF/ExportXafReport/Program.vb#L24

    reportDataSourceHelper.SetupBeforePrint(report)
    report.ExportToPdf("test.pdf")
End Sub

Reporting_report-building-basics-e925/VB/Form1.vb#L41

    ' Export the report to PDF.
    report.ExportToPdf("report.pdf")
End Sub

Reporting_how-to-export-report-groups-to-different-files-e4006/VB/Form1.vb#L31

    Dim name_Conflict As String = Guid.NewGuid().ToString()
    newReport.ExportToPdf(name_Conflict & ".pdf")
End Using

reporting-winforms-export-pdf-digital-signature/VB/pdf-signature-sample/Form1.vb#L38

    ' created in the same folder where the application's .exe file is located.
    report.ExportToPdf("test.pdf")
End Sub

Reporting_how-to-list-all-reports-available-in-an-application-t110546/VB/WindowsFormsApplication1/Form1.vb#L31

    Dim report As XtraReport = TryCast(Activator.CreateInstance(reportType), XtraReport)
    report.ExportToPdf(folderBrowserDialog1.SelectedPath & "\" & reportType.Name & ".pdf")
Next item