PdfExportOptions Class

Contains options that define how a document is exported to PDF format.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.1.Core.dll

Declaration

C#

public class PdfExportOptions :
    PageByPageExportOptionsBase,
    IXtraSupportShouldSerialize

VB.NET

Public Class PdfExportOptions
    Inherits PageByPageExportOptionsBase
    Implements IXtraSupportShouldSerialize

Related API Members

The following members accept/return PdfExportOptions objects:

• ExportOptions.Pdf

Remarks

To learn more, see the Export to PDF topic.

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.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);
            }

        }

    }
}

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfExportOptions class.

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-customize-export-options-of-the-printing-system-in-winforms-e2108/CS/WinSolution.Module.Win/ConfigurePrintingSystemViewController.cs#L44

}
private static void SetPdfOptions(PdfExportOptions pdfExportOptions) {
    // PDF-specific options:

Reporting_how-to-save-print-a-selected-page-of-a-report-in-a-web-application-t113072/CS/WebApplication1/ExportReport.aspx.cs#L18

ps.LoadDocument(ms);
PdfExportOptions opts = new PdfExportOptions();
opts.ShowPrintDialogOnOpen = false;//<= Set to true to open print dialog by default

Reporting_report-server-get-the-list-of-reports-and-display-a-preview-in-a-winforms-e5062/CS/ReportServerWinFormsClientDemo/MainForm.cs#L81

splashScreenManager1.ShowWaitForm();
Task.Factory.ExportReportAsync(serverConnection.CreateClient(), new ReportIdentity(reportId), new PdfExportOptions(), null, null)
    .ContinueWith(task => {

Reporting_report-server-how-to-get-available-reports-and-show-them-in-wpf-document-viewer-t258870/CS/T258870/ViewModel/MainViewModel.cs#L76

void ExportToPdf(ConnectionProvider serverConnection, string fileName, int reportId) {
    Task.Factory.ExportReportAsync(serverConnection.CreateClient(), new ReportIdentity(reportId), new PdfExportOptions(), null, null)
        .ContinueWith(task => {

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L386

//Set the required export options:
DevExpress.XtraPrinting.PdfExportOptions options = new DevExpress.XtraPrinting.PdfExportOptions();
options.DocumentOptions.Author = "Mark Jones";

VB.NET

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/VB/WinSolution.Module.Win/ConfigurePrintingSystemViewController.vb#L45

End Sub
Private Shared Sub SetPdfOptions(ByVal pdfExportOptions As PdfExportOptions)
    ' PDF-specific options:

Reporting_how-to-save-print-a-selected-page-of-a-report-in-a-web-application-t113072/VB/WebApplication1/ExportReport.aspx.vb#L20

ps.LoadDocument(ms)
Dim opts As New PdfExportOptions()
opts.ShowPrintDialogOnOpen = False '<= Set to true to open print dialog by default

Reporting_report-server-get-the-list-of-reports-and-display-a-preview-in-a-winforms-e5062/VB/ReportServerWinFormsClientDemo/MainForm.vb#L80

splashScreenManager1.ShowWaitForm()
Task.Factory.ExportReportAsync(serverConnection.CreateClient(), New ReportIdentity(reportId), New PdfExportOptions(), Nothing, Nothing).ContinueWith(Sub(task)
    splashScreenManager1.CloseWaitForm()

Reporting_report-server-how-to-get-available-reports-and-show-them-in-wpf-document-viewer-t258870/VB/T258870/ViewModel/MainViewModel.vb#L93

Private Sub ExportToPdf(ByVal serverConnection As ConnectionProvider, ByVal fileName As String, ByVal reportId As Integer)
    Task.Factory.ExportReportAsync(serverConnection.CreateClient(), New ReportIdentity(reportId), New PdfExportOptions(), Nothing, Nothing).ContinueWith(Sub(task)
        IsBusy = False

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L393

'Set the required export options:
Dim options As New DevExpress.XtraPrinting.PdfExportOptions()
options.DocumentOptions.Author = "Mark Jones"

Inheritance

Object

ExportOptionsBase

PageByPageExportOptionsBase

PdfExportOptions