Obtain the Current Page Number when Printing a Control

• Aug 18, 2023

This example demonstrates how to obtain the number of the page that is currently printing.

You can obtain both the current and total number of document pages using the PrintOnPageEventArgs.PageCount and PrintOnPageEventArgs.PageIndex properties in the XRControl.PrintOnPage event handler. The PrintOnPageEventArgs.PageIndex property indicates the zero-based page index.

Tip

The XRControl.PrintOnPage event is raised after both the XRControl.BeforePrint and XRControl.AfterPrint events. See Report Events for more information.

C#

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

private void xrLabel1_PrintOnPage(object sender, PrintOnPageEventArgs e) {
    if (e.PageCount > 0) {
        // Check if the control is printed on the first page.
        if (e.PageIndex == 0) {
            // Cancels the control's printing.
            e.Cancel = true;
        }
    }
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Private Sub xrLabel1_PrintOnPage(ByVal sender As Object, _ 
ByVal e As PrintOnPageEventArgs) Handles xrLabel1.PrintOnPage
    If e.PageCount > 0 Then
        ' Check if the control is printed on the first page.
        If e.PageIndex = 0 Then
            ' Cancels the control's printing.
            e.Cancel = True
        End If
    End If
End Sub

Tip

You need to handle the corresponding script event to serialize your custom logic with the report’s definition and maintain it in end-user applications.

Consider using the XRPageInfo control for displaying page numbers in a report.