PrintOnPageEventArgs Class

Provides data for the XRControl.PrintOnPage event.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

public class PrintOnPageEventArgs :
    PrintEventArgs
Public Class PrintOnPageEventArgs
    Inherits PrintEventArgs

The XRControl.PrintOnPage event occurs when the representation of a control is printed on the current page of the report. A PrintOnPageEventArgs specifies the PrintOnPageEventArgs.PageIndex of the current page.

Examples

The following example demonstrates how to use the XRControl.PrintOnPage event. The event handler below checks if an xrLabel1 is being printed on the last page (in case the PrintOnPageEventArgs.PageCount property is equal to PrintOnPageEventArgs.PageIndex minus 1), and, if yes, sets its text to "The last page!". Otherwise, it checks if a label is being printed on the odd page, and, if yes, it cancels its printing.

using DevExpress.XtraReports.UI;
// ...

private void xrLabel1_PrintOnPage(object sender, PrintOnPageEventArgs e) {
    // Check if the label is printed on the last page.
    // Note that the PageCount property value is not valid if you
    // use the CachedReportSource component to generate a report document
    if (e.PageIndex == e.PageCount-1)
        // Set its text.
        ((XRLabel)sender).Text = "The last page!";
    else
        // Check if the label is printed on the odd page.
        if (e.PageIndex % 2 == 0)
            // Cancel its printing.
            e.Cancel = true;
}

Inheritance

Object
PrintOnPageEventArgs

See Also