Header placement

The header is a horizontal region extending from the top of the page to the body of text or image.  If header placement is declared in any barcode or text commands on a page, then a clear area is created on the top of the page.  The height of this area is the minimum size that will accommodate all the header elements.  The original page is scaled down to fit between the bottom of the header and the bottom of the page (or the top of the footer if it is also present).  It is possible to explicitly specify the distance for the barcode or text from position from the edge of the page within the header.      

Header placement example

Header and footer placement example

headerfooter-header-30dpi.jpg headerfooter-header-footer-30dpi.jpg

   

Syntax

To create a header region and use the implicit alignment, bottomleft:bottomleft with default margins.  

barcode target=header, BarcodeValue

 

To create a header region and use implicit topleft:topleft alignment with specified margins

barcode target=header ,left=LeftMargin [,top=TopMargin], BarcodeValue

 

To create a header region and use implicit topright:topright alignment with specified margins

barcode target=header, right=RightMargin [, top=TopMargin], BarcodeValue

 

To create a header region and use explicit alignment with default or the established margins set by the margins command

barcode target=header:TargetAP[:ElementAP], BarcodeValue

 

To create a header region and use explicit alignment with specified margins

barcode target=header[:TargetAP[:ElementAP]]:AllMargins, BarcodeValue

barcode target=header[:TargetAP[:ElementAP]]:HorzlMargins:VertMargins, BarcodeValue

barcode target=header[:TargetAP[:ElementAP]]:LeftMargin:TopMargin:RightMargin:BottomMargin, BarcodeValue

Parameters

LeftMargin

 Left margin 

TopMargin

Top margin.

RightMargin

Right margin

BottomMargin

Bottom margin

AllMargins

 Left, top, right, bottom margins

HorzMargins

 Left and right margins.

VertMargins

 Top and bottom margins.

TargetAP

Target alignment point.  Only topleft, topcenter and topright values are valid.  (see the Object Placement diagram)
Default value is topleft

ElementAP

 Element alignment point.  Default value is the same as TargetAP

Notes

Examples

Place barcode with default topleft:topleft alignment. Use default margins.

barcode target=header, ${DocumentID}${page:00}${pages:00}

Place text in the top center of the header.

text target=header:tc:tc, "This is my Document"

Place text in the top right if the header. Explicitly specify margins.

text target=header:tr:tr, top=0.1, right=0.2, "Page ${page} of $pages}

Syntax legend
 

Format

Meaning

Italic

Information that the user must supply
 

Bold

Elements that the user must type exactly as shown.

Between brackets ([])

Optional items
 

Ellipsis (...)

Parameter that can be repeated several times