Document.Pages Property

Provides access to the collection of pages within the current document.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v20.2.Core.dll

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

Declaration

C#

public PageList Pages { get; }

VB.NET

Public ReadOnly Property Pages As PageList

Property Value

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

Remarks

After Printing System has generated a Document (e.g., on calling the LinkBase.CreateDocument or XtraReport.CreateDocument method), you can access the collection of document pages using the Pages property. This enables you to reorder pages, add pages from other documents or insert blank pages using the PrintingSystemBase.CreatePage method.

The Document.IsModified property returns true if the collection of pages has been modified after its creation.

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_how-to-scroll-a-document-in-the-print-preview-to-a-specific-page-or-brick-e2386/CS/Form1.cs#L37

private void button3_Click(object sender, EventArgs e) {
    DevExpress.XtraPrinting.Page page = printingSystem1.Document.Pages[3];
    DevExpress.XtraPrinting.BrickEnumerator brickEnumerator = page.GetEnumerator();

Reporting_how-to-check-which-control-initiates-creating-extra-empty-pages-after-every-page-in-e2338/CS/Form1.cs#L61

Dictionary<string, ReportControlDescriptor> controls = new Dictionary<string, ReportControlDescriptor>();
Page p = r.PrintingSystem.Document.Pages[pageNumber - 1];
BrickEnumerator be = p.GetEnumerator();

Reporting_how-to-create-a-document-map-bookmarks-e147/CS/DocumentBookmarks/Form1.cs#L63

foreach (BrickPagePair pair in pairs) {
    Page page = document.Pages[pair.PageIndex];

VB.NET

Reporting_how-to-scroll-a-document-in-the-print-preview-to-a-specific-page-or-brick-e2386/VB/Form1.vb#L36

Private Sub button3_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button3.Click
    Dim page As DevExpress.XtraPrinting.Page = printingSystem1.Document.Pages(3)
    Dim brickEnumerator As DevExpress.XtraPrinting.BrickEnumerator = page.GetEnumerator()

Reporting_how-to-check-which-control-initiates-creating-extra-empty-pages-after-every-page-in-e2338/VB/Form1.vb#L65

Dim controls_Renamed As New Dictionary(Of String, ReportControlDescriptor)()
Dim p As Page = r.PrintingSystem.Document.Pages(pageNumber - 1)
Dim be As BrickEnumerator = p.GetEnumerator()

Reporting_how-to-create-a-document-map-bookmarks-e147/VB/DocumentBookmarksVB/Form1.vb#L56

For Each Pair In Pairs
    Dim page As Page = document.Pages(Pair.PageIndex)
    Dim brick As Brick = CType(page.GetBrickByIndices(Pair.BrickIndices), Brick)