PrintOnPageEventArgs.PageIndex Property
Gets the index of the current page which the control will be printed on.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v24.1.dll
NuGet Package: DevExpress.Reporting.Core
Declaration
Property Value
| Type | Description |
|---|---|
| Int32 | An integer value which specifies the current page index. Note that the first page’s index is equal to 0. |
Remarks
The XRControl.PrintOnPage event is raised repeatedly for each control every time its view data is printed on the existing report page. The PageIndex property allows the index of the current page to be retrieved. Use this property to change some of the property values of a printed XRControl. Note that you’re also able to cancel the control’s printing by setting the Cancel property to true.
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 snippets (auto-collected from DevExpress Examples) contain references to the PageIndex 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.