PageArea Class

Serves as the base for classes that specify information to be displayed in page header and page footer areas.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public class PageArea

VB.NET

Public Class PageArea

Related API Members

The following members return PageArea objects:

• PageHeaderFooter.Footer
• PageHeaderFooter.Header

Remarks

The PageArea class introduces the PageArea.Content property that contains three strings, specifying the kind of information to be displayed in a page header and page footer. In addition, this class introduces the PageArea.Font and PageArea.LineAlignment properties, that determine the appearance of this information.

Example

This example demonstrates how to use the link’s PageHeaderFooter to add extra information to the document’s page header.

Tip

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E1021.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
// ...

private void button1_Click(object sender, EventArgs e) {
    string leftColumn = "Pages: [Page # of Pages #]";
    string middleColumn = "User: [User Name]";
    string rightColumn = "Date: [Date Printed]";

    // Create a PageHeaderFooter object and initializing it with
    // the link's PageHeaderFooter.
    PageHeaderFooter phf = printableComponentLink1.PageHeaderFooter as PageHeaderFooter;

    // Clear the PageHeaderFooter's contents.
    phf.Header.Content.Clear();

    // Add custom information to the link's header.
    phf.Header.Content.AddRange(new string[] { leftColumn, middleColumn, rightColumn });
    phf.Header.LineAlignment = BrickAlignment.Far;

    // Show the document's preview.
    printableComponentLink1.ShowPreview();
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraPrinting
' ...

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _
Handles button1.Click
    Dim leftColumn As String = "Pages: [Page # of Pages #]"
    Dim middleColumn As String = "User: [User Name]"
    Dim rightColumn As String = "Date: [Date Printed]"

    ' Create a PageHeaderFooter object and initializing it with
    ' the link's PageHeaderFooter.
    Dim phf As PageHeaderFooter = _
        TryCast(printableComponentLink1.PageHeaderFooter, PageHeaderFooter)

    ' Clear the PageHeaderFooter's contents.
    phf.Header.Content.Clear()

    ' Add custom information to the link's header.
    phf.Header.Content.AddRange(New String() _
        {leftColumn, middleColumn, rightColumn})
    phf.Header.LineAlignment = BrickAlignment.Far

    ' Show the document's preview.
    printableComponentLink1.ShowPreview()
End Sub

Inheritance

Object

PageArea

PageFooterArea

PageHeaderArea