TCPDF::addHTMLTOC( $page = '', $toc_name = 'TOC', $templates = array(), $correct_align = true, $style = '', $color = array(0, 0, 0) )
Output a Table Of Content Index (TOC) using HTML templates.
Description Description
This method must be called after all Bookmarks were set. Before calling this method you have to open the page using the addTOCPage() method. After calling this method you have to call endTOCPage() to close the TOC page.
See also See also
- addTOCPage(),: endTOCPage(), addTOC()
Parameters Parameters
- $page
-
(Optional) (int) page number where this TOC should be inserted (leave empty for current page).
Default value: ''
- $toc_name
-
(Optional) (string) name to use for TOC bookmark.
Default value: 'TOC'
- $templates
-
(Optional) (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.
Default value: array()
- $correct_align
-
(Optional) (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
Default value: true
- $style
-
(Optional) (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
Default value: ''
- $color
-
(Optional) (array) RGB color array for title (values from 0 to 255).
Default value: array(0, 0, 0)
Source Source
File: includes/lib/tcpdf/tcpdf.php
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.001 | Introduced. |