Page Class

A single document page.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.1.Core.dll

Declaration

C#

[BrickExporter(typeof(PageExporter))]
public abstract class Page :
    BrickBase,
    IEnumerable,
    IXtraSerializable,
    IPage,
    IPageItem,
    IDisposable

VB.NET

<BrickExporter(GetType(PageExporter))>
Public MustInherit Class Page
    Inherits BrickBase
    Implements IEnumerable,
               IXtraSerializable,
               IPage,
               IPageItem,
               IDisposable

Related API Members

The following members accept/return Page objects:

Show 11 links

Library	Related API Members
Cross-Platform Class Library	BrickPagePair.GetPage(PageList)
	EditingField.GetPage()
	IPrintingSystemContext.DrawingPage
	PageEventArgs.Page
	PageList.First
	PageList.Item[Int32]
	PageList.Last
	PagePaintEventArgs.Page
	PrintingSystemBase.CreatePage()
WinForms Controls	BrickEventArgs.Page
WPF Controls	PageViewModelBase.Page

Remarks

The Page class contains information about a document page’s bricks.

All document pages are listed in the PageList collection. The index of an individual page within the collection can be obtained via the Page.Index property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Page class.

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-create-a-custom-table-of-contents-for-merged-reports-with-page-indexes-t328491/CS/CustomTableOfContents/TargetBrick.cs#L10

    public VisualBrick Brick { get; set; }
    public Page Page { get; set; }
}

Reporting_how-to-add-a-brick-with-vertical-text-to-the-margin-of-each-report-page-t457705/CS/T457705/XtraReport1.cs#L19

SizeF size = this.PrintingSystem.Graph.MeasureString(text, font);
foreach(Page page in this.Pages) {
    LabelBrick labelBrick = CreateLabel(page, font, size, text);

Reporting_how-to-generate-a-page-oriented-txt-file-from-a-report-instance-indicate-page-t251095/CS/WindowsFormsApplication1/Form1.cs#L31

{
    foreach (Page page in report.Pages)
    {

Reporting_how-to-add-different-watermarks-to-document-pages-e109/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-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();

VB.NET

Reporting_how-to-create-a-custom-table-of-contents-for-merged-reports-with-page-indexes-t328491/VB/CustomTableOfContents/TargetBrick.vb#L10

    Public Property Brick() As VisualBrick
    Public Property Page() As Page
End Class

Reporting_how-to-add-a-brick-with-vertical-text-to-the-margin-of-each-report-page-t457705/VB/T457705/XtraReport1.vb#L21

Dim brickSize As SizeF = Me.PrintingSystem.Graph.MeasureString(brickText, brickFont)
For Each page As Page In Me.Pages
    Dim labelBrick As LabelBrick = CreateLabel(page, brickFont, brickSize, brickText)

Reporting_how-to-generate-a-page-oriented-txt-file-from-a-report-instance-indicate-page-t251095/VB/WindowsFormsApplication1/Form1.vb#L28

Using writer As StreamWriter = File.CreateText("FINALOUTPUT.txt")
    For Each page As Page In report.Pages
        Dim ps As New PrintingSystem()

Reporting_how-to-add-different-watermarks-to-document-pages-e109/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-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()

Implements

IPage

Inheritance

Object

DevExpress.Printing.Utils.DocumentStoring.StorableObjectBase

BrickBase

Page