PrintOnPageEventArgs Class

Provides data for the XRControl.PrintOnPage event.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public class PrintOnPageEventArgs :
    CancelEventArgs

VB.NET

Public Class PrintOnPageEventArgs
    Inherits CancelEventArgs

Related API Members

PrintOnPageEventArgs is the data class for the following events:

• Band.PrintOnPage
• SubreportBase.PrintOnPage
• XRControl.PrintOnPage
• XRCrossBandControl.PrintOnPage
• XRCrossTab.PrintOnPage
• XRPageBreak.PrintOnPage
• XRPdfContent.PrintOnPage
• XRPivotGrid.PrintOnPage

Remarks

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.

Example

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.

C#

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

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Private Sub OnLabelPrintOnPage(ByVal sender As Object, ByVal e As PrintOnPageEventArgs) _
Handles xrLabel1.PrintOnPage
    ' Check if the label is printed on the last page.
    If e.PageIndex = e.PageCount - 1 Then
        ' Set its text.
        CType(sender, XRLabel).Text = "The last page!"
    Else
        ' Check if the label is printed on the odd page.
        If e.PageIndex Mod 2 = 0 Then
            ' Cancel its printing.
            e.Cancel = True
        End If
    End If
End Sub

Inheritance

Object

EventArgs

CancelEventArgs

PrintOnPageEventArgs