Template PDF functions
| Name | Summary |
|---|---|
| anchor | Creates an internal link anchor. |
| create_index | Creates an index based on the specified keywords. |
| filled_circle | Creates a filled circle. |
| filled_rectangle | Creates a filled rectangle. |
| footer | Sets the footer. |
| footer_block | Inserts complex footers. |
| frame_header | Sets the header text. |
| frontpage | Adds content to the frontpage. |
| header | Inserts a header / title. |
| header_block | Inserts a complex header. |
| image | Inserts an image to the PDF document. |
| keyword | Adds a keyword to the keyword index. |
| line | Draws a line. |
| link | Inserts an external link. |
| new_line | Inserts a new line. |
| new_page | Inserts a new page. |
| page_number | Starts the page number counter. |
| set_font | Changes the default font. |
| set_margin | Sets the page margins or line spacing. |
| strike | Inserts striked text. |
| table | Inserts a table. |
| text | This function inserts formatted text into the PDF document. |
| text_box | Inserts text at a specified location. |
| text_frame | Inserts a text with a frame. |
| toc | Inserts a generated table of contents. |
| ul | Inserts a bullet list. |
In this section
- anchor Exponential Documentation
- create_index This function creates an index page from a collection of keywords. The keywords must be specified using the "keyword" PDF template function. The index will start on the next page, and consists of the specified keywords with their corresponding page number.
- filled_circle This function creates a filled circle with a given radius and color. The position of the circle is specified with the "x" and "y" parameters. The given coordinate must be within the page margins. The lower-left corner is at (0,0).
- filled_rectangle This function creates a filled rectangle. The "x" and "y" parameters specify the lower-left corner of the rectangle. The "width" and "height" parameters determine the size of the rectangle.
- footer Exponential Documentation
- footer_block Exponential Documentation
- frame_header Exponential Documentation
- frontpage This function makes it possible to add text to the front page. If the frontpage is not present, a new front page will be created when the function is used for the first time. This function should be called after all other content has been added to the PDF document. The "align" and "size" parameters
- header This function inserts a header or title. The main difference between the "text" and the header function is the "level" parameter. This parameter specifies the type of the header. The level number goes from 1 and up:
- header_block Exponential Documentation
- image This function makes it possible to insert an image. The image location or image source points to the root directory of the eZ publish installation. The image location is relative to this directory. Currently, the supported image types are "jpg" and "png" without alpha channel.
- keyword Exponential Documentation
- line This function draws a line. The line will be drawn from the (x1, y1) coordinate to the (x2, y2) coordinate. If the "pages" parameter is omitted or set to "current", the line will only be present on the current page. If "pages" is set to all, it will appear on all the pages. The thickness of the line
- link Exponential Documentation
- new_line This function inserts a new line.
- new_page This function inserts a new page, following content will be placed on a new page. Please note that the system automatically takes care of adding new pages when needed. This function simply makes it possible to manually insert a new page.
- page_number Exponential Documentation
- set_font This function makes it possible to change the default/current font and the text color, style, etc. The following list shows the fonts that can be used.
- set_margin This function sets the page margins of the current and following pages. The "left", "right", "top", and "bottom" parameters specify the distances from the edges. The parameters "x" and "y" specify a point on the current page where the new margin starts. For the next pages, the parameters "x" and "y"
- strike Exponential Documentation
- table Exponential Documentation
- text This function inserts regular text into the PDF document. The font type, font size, font color, and text alignment can be specified. If not specified, this function uses the current settings. The available font types are:
- text_box This function creates a text box at the specified place on the current page. The font properties (type, size, and color) are not affected by the "set_font" function.
- text_frame This function creates a text with a colored frame around it. The frame has the size of the text plus the amount of padding. The padding can be specified for each side of the text with the parameters "leftPadding", "rightPadding", "topPadding", and "bottomPadding". If the padding is equal for each si
- toc This function generates and inserts the table of contents after the front page. If the front page is not available, the table of contents is inserted at the beginning of the PDF document.
- ul This function inserts a bullet list into the PDF document.
Contributors
- Balazs Halasy Updated
Comments
Add a comment