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.v18.2.Core.dll

Declaration

C#

[Browsable(true)]
public virtual object PageHeaderFooter { get; set; }

VB.NET

<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.

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PageHeaderFooter 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-save-load-a-documents-headers-and-footers-in-its-print-preview-e1908/CS/Form1.cs#L28

PageHeaderFooter phf = printableComponentLink1.PageHeaderFooter as PageHeaderFooter;
phf.Header.Content.AddRange(new string[] { "",

Reporting_how-to-insert-system-information-to-the-page-header-and-footer-e1021/CS/Form1.cs#L28

// the link's PageHeaderFooter.
PageHeaderFooter phf = printableComponentLink1.PageHeaderFooter as PageHeaderFooter;

VB.NET

Reporting_how-to-save-load-a-documents-headers-and-footers-in-its-print-preview-e1908/VB/Form1.vb#L34

Dim phf As PageHeaderFooter = TryCast(printableComponentLink1.PageHeaderFooter, PageHeaderFooter)
phf.Header.Content.AddRange(New String() { "", "Change Page Header/Footer, then close and re-open the form.", "" })

Reporting_how-to-insert-system-information-to-the-page-header-and-footer-e1021/VB/Form1.vb#L27

' the link's PageHeaderFooter.
Dim phf As PageHeaderFooter = TryCast(printableComponentLink1.PageHeaderFooter, PageHeaderFooter)