PdfDocumentProcessor.PrintPage Event

Occurs when the document page is printed.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public event PdfPrintPageEventHandler PrintPage

VB.NET

Public Event PrintPage As PdfPrintPageEventHandler

Event Data

The PrintPage event's data class is PdfPrintPageEventArgs. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets a value indicating whether the print job should be canceled. Inherited from PrintPageEventArgs.
Graphics	Gets the Graphics used to paint the page. Inherited from PrintPageEventArgs.
HasMorePages	Gets or sets a value indicating whether an additional page should be printed. Inherited from PrintPageEventArgs.
MarginBounds	Gets the rectangular area that represents the portion of the page inside the margins. Inherited from PrintPageEventArgs.
PageBounds	Gets the rectangular area that represents the total area of the page. Inherited from PrintPageEventArgs.
PageCount	Returns the total number of pages which were sent to the printer.
PageNumber	Returns the page number of the currently printed page.
PageSettings	Gets the page settings for the current page. Inherited from PrintPageEventArgs.

Remarks

Use this event to perform actions when the document is sent to a printer. The page number of the currently printed page and the total number of pages which were sent to the printer can be accessed via the PdfPrintPageEventArgs.PageNumber and PdfPrintPageEventArgs.PageCount properties, respectively.

The print job can also be canceled by setting the Cancel property to true for the PrintPageEventArgs. For more information about other properties of PrintPageEventArgs, see the PrintPageEventArgs Class MSDN topic.

Example

This example shows how to customize print output and change settings for a page to be printed.

A document is printed with the specified initial printer settings using the PdfDocumentProcessor.Print method. In this example, the page numbers that should be printed in a document are specified using the PdfPrinterSettings.PageNumbers property.

When a page is printed, page settings for this page are queried via the PdfDocumentProcessor.QueryPageSettings event.

In this example, the second page of a document is printed in landscape orientation by setting the PdfQueryPageSettingsEventArgs.PageSettings.Landscape property to true when the PdfDocumentProcessor.QueryPageSettings event is handled.

When the document is sent to a printer, the PdfDocumentProcessor.PrintPage event is raised.

To draw an additional image on a printed page, the Graphics property of the PdfPrintPageEventArgs is used when the PdfDocumentProcessor.PrintPage event is handled. This image is drawn on each page by calling the Graphics.DrawImage method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-pdf-print-output-t334688

Program.cs

using DevExpress.Pdf;
using System.Drawing;

namespace CustomizePrintSettings {
    class Program {
        static void Main(string[] args) {

            // Create a PDF Document Processor instance and load a PDF into it.
            using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {
                documentProcessor.LoadDocument(@"..\..\Demo.pdf");

                // Declare the PDF printer settings.
                PdfPrinterSettings settings = new PdfPrinterSettings();

                // Specify the page numbers to be printed.
                settings.PageNumbers = new int[] { 1, 2, 3, 4, 5, 6 };

                // Handle the PrintPage event to specify print output.
                documentProcessor.PrintPage += OnPrintPage;

                // Handle the QueryPageSettings event to customize settings for a page to be printed.
                documentProcessor.QueryPageSettings += OnQueryPageSettings;

                // Print the document using the specified printer settings.
                documentProcessor.Print(settings);

                // Unsubscribe from PrintPage and QueryPageSettings events. 
                documentProcessor.PrintPage -= OnPrintPage;
                documentProcessor.QueryPageSettings -= OnQueryPageSettings;
            }
        }

        private static void OnQueryPageSettings(object sender, PdfQueryPageSettingsEventArgs e) {
            // Print the second page in landscape size.
            if (e.PageNumber == 2) {
                e.PageSettings.Landscape = true;
            }
            else e.PageSettings.Landscape = false;
        }

        // Specify what happens when the PrintPage event is raised.
        private static void OnPrintPage(object sender, PdfPrintPageEventArgs e) {

            // Draw a picture on each printed page.        
            using (Bitmap image = new Bitmap(@"..\..\DevExpress.png"))

                e.Graphics.DrawImage(image, new RectangleF(10, 30, image.Width / 2, image.Height / 2));
        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing

Namespace CustomizePrintSettings
    Friend Class Program
        Shared Sub Main(ByVal args() As String)

            ' Create a PDF Document Processor instance and load a PDF into it.
            Using documentProcessor As New PdfDocumentProcessor()
                documentProcessor.LoadDocument("..\..\Demo.pdf")

                ' Declare the PDF printer settings.
                Dim settings As New PdfPrinterSettings()

                ' Specify the page numbers to be printed.
                settings.PageNumbers = New Integer() { 1, 2, 3, 4, 5, 6 }

                ' Handle the PrintPage event to specify print output.
                AddHandler documentProcessor.PrintPage, AddressOf OnPrintPage

                ' Handle the QueryPageSettings event to customize settings for a page to be printed.
                AddHandler documentProcessor.QueryPageSettings, AddressOf OnQueryPageSettings

                ' Print the document using the specified printer settings.
                documentProcessor.Print(settings)

                ' Unsubscribe from PrintPage and QueryPageSettings events. 
                RemoveHandler documentProcessor.PrintPage, AddressOf OnPrintPage
                RemoveHandler documentProcessor.QueryPageSettings, AddressOf OnQueryPageSettings
            End Using
        End Sub

        Private Shared Sub OnQueryPageSettings(ByVal sender As Object, ByVal e As PdfQueryPageSettingsEventArgs)
            ' Print the second page in landscape size.
            If e.PageNumber = 2 Then
                e.PageSettings.Landscape = True
            Else
                e.PageSettings.Landscape = False
            End If
        End Sub

        ' Specify what happens when the PrintPage event is raised.
        Private Shared Sub OnPrintPage(ByVal sender As Object, ByVal e As PdfPrintPageEventArgs)

            ' Draw a picture on each printed page.        
            Using image As New Bitmap("..\..\DevExpress.png")

                e.Graphics.DrawImage(image, New RectangleF(10, 30, image.Width \ 2, image.Height \ 2))
            End Using
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PrintPage event.

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#

pdf-document-api-customize-pdf-print-output/CS/CustomizePrintSettings/Program.cs#L19

// Handle the PrintPage event to specify print output.
documentProcessor.PrintPage += OnPrintPage;

VB.NET

pdf-document-api-customize-pdf-print-output/VB/CustomizePrintSettings/Program.vb#L17

' Handle the PrintPage event to specify print output.
AddHandler documentProcessor.PrintPage, AddressOf OnPrintPage
' Handle the QueryPageSettings event to customize settings for a page to be printed.