ez.no / exponential / documentation / reference / template operators / pdf / frame_header
{pdf(frame_header, hash( [ text, text, ]
[ align, text_alignment, ]
[ page, page_interval, ]
[ pageOffset, page_offset, ]
[ size, font_size, ]
[ font, font_name, ]
[ margin, hash( [ bottom, bottom_margin, ]
[ left, left_margin, ]
[ right, right_margin, ] ), ]
[ line, hash( [ leftMargin, left_margin, ]
[ rightMargin, right_margin, ]
[ thickness, line_thickness, ] ), ] ) ) }
| Name | Type | Description | Required |
|---|---|---|---|
| text | string | Header text | no |
| align | string | Text alignment | no |
| page | string | Page occurence, all, even or odd | no |
| pageOffset | integer | Page number to start footer at | no |
| size | integer | Font size | no |
| font | string | Font name | no |
| margin | hash | Margin definition | no |
| left | integer/float | Left header margin | no |
| right | integer/float | Right header margin | no |
| bottom | integer/float | Bottom footer margin | no |
| line | hash | Line definition | no |
| leftMargin | integer/float | Left line margin | no |
| rightMargin | integer/float | Right line margin | no |
| thinkness | integer/float | Line thickness | no |
| newline | boolean | Force header entry to new line | no |
Create a header text field for specified pages in the PDF document.
Some strings are reserved for special functions:
- #page : will be replaced by the current page number.
- #total : will be replaces by the total number of pages.
The header should only be included once in the PDF document. Please used the {include-once} or other techniques to ensure this.
Available from 3.3 and newer
newline available from 3.4 and newer
{pdf(frame_header, hash( text, $node.name|wash(pdf), size, 10, align, "left" ) ) } {pdf(frame_header, hash( text, "#page of #total"|i18n( "design/standard/content/pdf" )|wash(pdf), align, "right", size, 10 ) ) } {pdf(frame_header, hash( line, hash( margin, 80, thicknes, 1, size, "full" ) ) ) }
log in or create a user account to comment.
Comments