PageHeaderFooter.Header Property

Provides access to the page header area.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Content)]
public PageArea Header { get; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Content)>
Public ReadOnly Property Header As PageArea

Property Value

Type	Description
PageArea	A PageArea object representing the page header.

Remarks

Use the Header property to insert information (system information like page numbers or current date and user name, or any custom information) into the page header. For this, add three strings (left, center and right) to the collection, returned by the PageArea.Content property of the Header object.

Also, the PageArea.Font property specifies the font used to draw the page header’s text, and the PageArea.LineAlignment property specifies to which edge (top, center or bottom) of the page header its content should be aligned.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the Header 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-insert-system-information-to-the-page-header-and-footer-e1021/CS/Form1.cs#L31

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

VB.NET

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

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