How To: Export Document to PDF format

• Apr 03, 2019
• 2 minutes to read

User Interface

End-users can use the Print Preview command in the Ribbon UI to invoke the Preview window. In that window the Export - Export To - PDF File command displays the PDF Export Options dialog and subsequently allows specifying the file name and location to save a document as PDF file.

API

Export to PDF is performed using the RichEditControl.ExportToPdf method.

Note

A complete sample project is available at: The RichEditControl’s common API

The following code loads the sample document, specifies export options using the PdfExportOptions settings and exports it to PDF. It invokes the default PDF viewer to display the resulting document.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

C#

static void buttonCustomAction_ItemClick_PDF(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    richEdit.LoadDocument("Documents\\Grimm.docx");
    //Set the required export options:
    DevExpress.XtraPrinting.PdfExportOptions options = new DevExpress.XtraPrinting.PdfExportOptions();
    options.DocumentOptions.Author = "Mark Jones";
    options.Compressed = false;
    options.ImageQuality = DevExpress.XtraPrinting.PdfJpegImageQuality.High;
    //Export the document to the file:
    richEdit.ExportToPdf("resultingDocument.pdf", options);
    //Export the document to the file stream:
    using (FileStream pdfFileStream = new FileStream("resultingDocumentFromStream.pdf", FileMode.Create)) {
        richEdit.ExportToPdf(pdfFileStream, options);
    }

    System.Diagnostics.Process.Start("resultingDocument.pdf");
}

VB.NET

Shared Sub buttonCustomAction_ItemClick_PDF(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    richEdit.LoadDocument("Documents\Grimm.docx")
    'Set the required export options:
    Dim options As New DevExpress.XtraPrinting.PdfExportOptions()
    options.DocumentOptions.Author = "Mark Jones"
    options.Compressed = False
    options.ImageQuality = DevExpress.XtraPrinting.PdfJpegImageQuality.High
    'Export the document to the file:
    richEdit.ExportToPdf("resultingDocument.pdf", options)
    'Export the document to the file stream:
    Using pdfFileStream As New IO.FileStream("resultingDocumentFromStream.pdf", IO.FileMode.Create)
        richEdit.ExportToPdf(pdfFileStream, options)
    End Using

    System.Diagnostics.Process.Start("resultingDocument.pdf")
End Sub