PageArea.LineAlignment Property

Gets or sets a value specifying which edge (top, center or bottom) of the page area its content should be aligned.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

[XtraSerializableProperty]
public BrickAlignment LineAlignment { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property LineAlignment As BrickAlignment

Property Value

Type	Description
BrickAlignment	A BrickAlignment enumeration value specifying the content alignment.

Available values:

Name	Description
None	Cancels brick alignment.
Near	Specifies that the text shall be aligned near the layout. In a left-to-right layout, the near position is left. In a right-to-left layout, the near position is right.
Center	Specifies whether a brick is aligned by the center of the layout rectangle.
Far	Specifies whether a brick is aligned away from the original position of the layout rectangle.

Remarks

The LineAlignment property specifies the alignment of the page area’s text defined by the PageArea.Content property.

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 LineAlignment 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#L35

phf.Header.Content.AddRange(new string[] { leftColumn, middleColumn, rightColumn });
phf.Header.LineAlignment = BrickAlignment.Far;

VB.NET

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

phf.Header.Content.AddRange(New String() { leftColumn, middleColumn, rightColumn })
phf.Header.LineAlignment = BrickAlignment.Far