XtraReport.Pages Property

Gets a collection of pages generated for this report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

[Browsable(false)]
public PageList Pages { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property Pages As PageList

Property Value

Type	Description
PageList	A PageList object, specifying a collection of pages.

Remarks

After calling the XtraReport.CreateDocument method (or after calling the PrintTool.ShowPreview or PrintTool.ShowPreviewDialog methods for the first time), you can access all pages of the generated Document using the Pages property.

The PageList object, which is the returned collection of pages, exposes methods that allow you to reorder and remove pages, as well as to add and insert pages from other reports (see Merging Reports for details).

The following code reorders document pages to produce a booklet (first page, last page, second page, last but one, third page, etc.):

C#

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

private void CreateBooklet() {
    // Create the 1st report and generate its document.
    XtraReport1 report1 = new XtraReport1();
    report1.CreateDocument();

    // Preserve the original page numbers on all pages.
    report1.PrintingSystem.ContinuousPageNumbering = false;

    // Create a booklet.
    int centerPageIndex = Convert.ToInt32((report1.Pages.Count - 1) / 2);
    for (int i = 0; i < centerPageIndex; i++) {
        report1.Pages.Insert(i * 2 + 1, report1.Pages[report1.Pages.Count - 1]);
    }

    // Show the Print Preview form (in a WinForms application).
    ReportPrintTool printTool = new ReportPrintTool(report1);
    printTool.ShowPreviewDialog();
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Private Sub CreateBooklet()
    ' Create the 1st report and generate its document.
    Dim report1 As XtraReport1 = New XtraReport1()
    report1.CreateDocument()

    ' Preserve the original page numbers on all pages.
    report1.PrintingSystem.ContinuousPageNumbering = False

    ' Create a booklet.
    Dim centerPageIndex As Integer = Convert.ToInt32((report1.Pages.Count - 1) / 2)
    Dim i As Integer = 0
    Do While i < centerPageIndex
        report1.Pages.Insert(i * 2 + 1, report1.Pages(report1.Pages.Count - 1))
        i += 1
    Loop

    ' Show the Print Preview form (in a WinForms application).
    Dim printTool As New ReportPrintTool(report1)
    printTool.ShowPreviewDialog()
End Sub

You can also add an empty page using the PrintingSystemBase.CreatePage method of the report’s XtraReport.PrintingSystem.

Use the PrintingSystemBase.ContinuousPageNumbering property to specify whether to update the page numbers after customizing the collection of pages or preserve the page numbers from the original document(s).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Pages 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-winforms-merge-reports/CS/Form1.cs#L33

// Add all pages of the 2nd report to the end of the 1st report.
report1.Pages.AddRange(report2.Pages);

reporting-winforms-watermark-different-pages/CS/Form1.cs#L22

// Add a custom watermark to the second page.
Page myPage = report.Pages[1];
myPage.AssignWatermark(CreateTextWatermark("Second Page"));

Reporting_how-to-insert-an-extra-page-after-every-report-bookmark-section-t328498/CS/WindowsFormsApplication1/Form1.cs#L31

XtraReportInformation targetReport;
PageList pages = report.Pages;

XAF_how-to-merge-reports-in-xaf-e4224/CS/Solution2.Module.Win/Controllers/ReportCustomController.cs#L34

coverPageReport.Pages.AddRange(e.Report.Pages);

Reporting_how-to-export-report-groups-to-different-files-e4006/CS/Form1.cs#L23

for (int j = ((Groups)report.groups[i]).StartPageIndex; j <= ((Groups)report.groups[i]).EndPageIndex; j++) {
    newReport.Pages.Add(report.Pages[j]);
}

VB.NET

reporting-winforms-merge-reports/VB/Form1.vb#L34

' Add all pages of the 2nd report to the end of the 1st report.
report1.Pages.AddRange(report2.Pages)
' Reset all page numbers in the resulting document.

reporting-winforms-watermark-different-pages/VB/Form1.vb#L24

' Add a custom watermark to the second page.
Dim myPage As Page = report.Pages(1)
myPage.AssignWatermark(CreateTextWatermark("Second Page"))

Reporting_how-to-insert-an-extra-page-after-every-report-bookmark-section-t328498/VB/WindowsFormsApplication1/Form1.vb#L33

Dim targetReport As XtraReportInformation
Dim pages As PageList = report.Pages

XAF_how-to-merge-reports-in-xaf-e4224/VB/Solution2.Module.Win/Controllers/ReportCustomController.vb#L35

coverPageReport.Pages.AddRange(e.Report.Pages)

Reporting_how-to-export-report-groups-to-different-files-e4006/VB/Form1.vb#L25

For j As Integer = DirectCast(report.groups(i), Groups).StartPageIndex To DirectCast(report.groups(i), Groups).EndPageIndex
    newReport.Pages.Add(report.Pages(j))
Next j