LinkBase.PageHeaderFooter Property

Gets or sets the object used to fill the document's area that is occupied by the page header and page footer.

Namespace: DevExpress.XtraPrinting

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

Declaration

[Browsable(true)]
public virtual object PageHeaderFooter { get; set; }
<Browsable(True)>
Public Overridable Property PageHeaderFooter As Object

Property Value

Type Description
Object

A Object used to fill the document's area that is occupied by the page header and page footer.

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