PrintOnPageEventArgs.PageCount Property

Gets the number of all pages presented in the created report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public int PageCount { get; }

VB.NET

Public ReadOnly Property PageCount As Integer

Property Value

Type	Description
Int32	An integer value which represents the number of all pages in a report.

Remarks

Use the PageCount property to obtain information on the number of pages presented in the created document. Note that this number isn’t defined when the XRControl.BeforePrint event is called. So, to be able to obtain the number of all report pages, you need to handle the XRControl.PrintOnPage event.

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

Related GitHub Examples

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

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#

Reporting_how-to-obtain-the-current-page-number-when-printing-a-control-e1952/CS/GetThePageNumber/XtraReport1.cs#L13

private void xrLabel1_PrintOnPage(object sender, PrintOnPageEventArgs e) {
    if (e.PageCount > 0) {
        // Check if the control is printed on the first page.

VB.NET

Reporting_how-to-obtain-the-current-page-number-when-printing-a-control-e1952/VB/GetThePageNumber/XtraReport1.vb#L15

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.