PageArea.Content Property

Provides access to a collection of strings, representing the content of a page header or page footer.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public StringCollection Content { get; }

VB.NET

Public ReadOnly Property Content As StringCollection

Property Value

Type	Description
StringCollection	A StringCollection object, containing content strings.

Remarks

The Content collection should always contain three strings: the first to be aligned to the left page margin, the second to be displayed in the middle between the left and right margins, and the third to be aligned to the right page margin. If you don’t want to include anything in the left area or the middle area of the header or footer, simply add the empty string as the first or second element in the collection.

Below is the list of special strings which can be used to insert page information. Note that these strings can differ from those listed below if the XtraPrinting Library is localized, and uses a language other than English. In this case, the current values of the corresponding PreviewStringId members should be used.

• “[Page #]” (represented by the DevExpress.XtraPrinting.Localization.PreviewStringId.PageInfo_PageNumber field);
• “[Page # of Pages #]” (represented by the DevExpress.XtraPrinting.Localization.PreviewStringId.PageInfo_PageNumberOfTotal field);
• “[Date Printed]” (represented by the DevExpress.XtraPrinting.Localization.PreviewStringId.PageInfo_PageDate field);
• “[Time Printed]” (represented by the DevExpress.XtraPrinting.Localization.PreviewStringId.PageInfo_PageTime field);
• “[User Name]” (represented by the DevExpress.XtraPrinting.Localization.PreviewStringId.PageInfo_PageUserName field);
• “[Image 0]”, “[Image 1]”, … “[Image N]” (where N is the index of the image in the Link.Images collection).

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 Content 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()