A newer version of this page is available. Switch to the current version.

PageHeaderFooter Class

Represents the object, containing information about the page header and page footer areas.

Namespace: DevExpress.XtraPrinting

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

Declaration

[TypeConverter("DevExpress.XtraPrinting.Design.HeaderFooterConverter,DevExpress.XtraPrinting.v18.2.Design")]
public class PageHeaderFooter
<TypeConverter("DevExpress.XtraPrinting.Design.HeaderFooterConverter,DevExpress.XtraPrinting.v18.2.Design")>
Public Class PageHeaderFooter

Remarks

The page header and page footer's content can be accessed via the PageArea.Content property of the PageHeaderFooter.Header and PageHeaderFooter.Footer, respectively. Also, their appearance is specified by the PageArea.Font and PageArea.LineAlignment properties of these areas.

Examples

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.

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();
}

Inheritance

Object
PageHeaderFooter
See Also