Class PDFNet.HTML2PDF_TOCSettings
PDFNet.HTML2PDF_TOCSettings
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Settings for table of contents.
|
| Method Attributes | Method Name and Description |
|---|---|
|
destroy()
Frees the native memory of the object.
|
|
|
setCaptionText(caption)
Caption text to be used with TOC.
|
|
|
setDottedLines(enable)
Use a dotted line when creating TOC?
|
|
|
setLevelIndentation(indentation)
Indentation used for every TOC level.
|
|
|
setLinks(enable)
Create links from TOC to actual content?
|
|
|
setTextSizeShrink(shrink)
How much to shrink font for every level, e.g.
|
|
|
setXsl(style_sheet)
xsl style sheet used to convert outline XML into a
table of content.
|
Method Detail
destroy()
Frees the native memory of the object.
setCaptionText(caption)
Caption text to be used with TOC.
- Parameters:
- {string} caption
- Text that will appear with the table of contents.
setDottedLines(enable)
Use a dotted line when creating TOC?
- Parameters:
- {boolean} enable
- Table of contents will use dotted lines.
setLevelIndentation(indentation)
Indentation used for every TOC level...
- Parameters:
- {number} indentation
- How much to indent each level, e.g. "2"
setLinks(enable)
Create links from TOC to actual content?
- Parameters:
- {boolean} enable
- Entries in table of contents will link to section in the PDF.
setTextSizeShrink(shrink)
How much to shrink font for every level, e.g. 0.8
- Parameters:
- {number} shrink
- Rate at which lower level entries will appear smaller
setXsl(style_sheet)
xsl style sheet used to convert outline XML into a
table of content.
- Parameters:
- {string} style_sheet
- Path to xsl style sheet to be used to generate this table of contents.