frame_header
Summary
Sets the header text.Usage
{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, ] ), ] ) ) }Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| text | string | The header text. | No. |
| align | string | The text alignment. | No. |
| page | string | Page occurence ("all", "even" or "odd"). | No. |
| pageOffset | integer | Page number to start footer at. | No. |
| size | integer | The font size. | No. |
| font | string | The 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. |
Description
This function is deprecated and should not be used.
Balazs Halasy (14/05/2004 9:45 am)
Balazs Halasy (04/05/2005 12:57 pm)
Comments
There are no comments.