PrintingSystemBase.ExportToPdf(String, PdfExportOptions) Method

Exports a document to the specified file path in PDF format using the defined PDF-specific options.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToPdf(
    string filePath,
    PdfExportOptions options
)

VB.NET

Public Sub ExportToPdf(
    filePath As String,
    options As PdfExportOptions
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the file name (including the full path) for the created PDF file.
options	PdfExportOptions	A PdfExportOptions object which specifies the PDF export options to be applied when a document 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 document to a PDF file using the specified PDF export options (e.g. PdfExportOptions.ImageQuality, PdfExportOptions.NeverEmbeddedFonts and so on).

Note that in this instance the current printing system’s export options, which are represented by the PdfExportOptions object returned by the ExportOptions.Pdf property of a printing system’s PrintingSystemBase.ExportOptions, are ignored.

If, instead, you want to use the current export options of a printing system, you should call the overloaded PrintingSystemBase.ExportToPdf method without the options parameter.

Note

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

For more information, see Export to PDF.