PrintOnPageEventArgs.PageCount Property
Gets the number of all pages presented in the created report.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v20.2.dll
NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core
Declaration
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.
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;
}
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.