- addBackgroundImage
- addFooter
- addHeader
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createCharacterStyle
- createListStyle
- createParagraphStyle
- docxSettings
- importHeadersAndFooters
- importListStyle
- importStyles
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
pdx:addTableContents
Inserts a Table of Contents (TOC) into the Word document.
Description
Element definition
This element allows you to include a Table of Contents in you Word document.
Attributes and sub-elements
options
| key | Description |
|---|---|
| autoUpdate | If true it will try to update the TOC when first opened. |
| displayLevels | Must be of the form "1-3" where the first number is the start level an the second the end level. If not defined all existing levels are shown. |
legend
The possible keys and values are:
| key | Description |
|---|---|
| text | The placeholder text that will be shown if the autoupdate option is not activated. |
The possible keys and values are:
| key | Description |
|---|---|
| pStyle | The WordML fragment object containing the contents for the even pages header |
| backgroundColor | Hexadecimal color value: FF0000, 000000... |
| bidi | Set to true for right to left languages like Hebrew or Arabic. |
| bold | If true the text will be shown in bold characters. |
| border | Available values are:
|
| borderBottom | Overwrites the general border type for the bottom border of the paragraph. |
| borderLeft | Overwrites the general border type for the left border of the paragraph. |
| borderTop | Overwrites the general border type for the top border of the paragraph. |
| borderRight | Overwrites the general border type for the right border of the paragraph. |
| borderColor | Hexadecimal color value: FF0000, 000000... |
| borderBottomColor | Overwrites the general border color for the bottom border of the paragraph. |
| borderLeftColor | Overwrites the general border color for the left border of the paragraph. |
| borderTopColor | Overwrites the general border color for the top border of the paragraph. |
| borderRightColor | Overwrites the general border color for the right border of the paragraph. |
| borderSpacing | Separation between border and text in points. |
| borderBottomSpacing | Overwrites the general border spacing for the bottom border of the paragraph. |
| borderLeftSpacing | Overwrites the general border spacing for the left border of the paragraph. |
| borderTopSpacing | Overwrites the general border spacing for the top border of the paragraph. |
| borderRightSpacing | Overwrites the general border spacing for the right border of the paragraph. |
| borderWidth | Border width in eigths of a point. |
| borderBottomWidth | Overwrites the general border width for the bottom border of the paragraph. |
| borderLeftWidth | Overwrites the general border width for the left border of the paragraph. |
| borderTopWidth | Overwrites the general border width for the top border of the paragraph. |
| borderRightWidth | Overwrites the general border width for the right border of the paragraph. |
| caps | If true displays text in capital letters. |
| color | Hexadecimal color value: 'FF0000', '000000'... |
| contextualSpacing | If true ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style (false by default). |
| firstLineIndent | First line indentation in twentieths of a point (twips). |
| font | Font family: 'Arial', Calibri'... |
| fontSize | Font size in points. |
| hanging | Paragraph hanging in twentieths of a point (twips). |
| headingLevel | The heading level if we want this paragraph to be a heading. |
| italic | If true displays the text in italics. |
| indentLeft | Left margin in points. |
| indentRight | Right margin in points |
| keepLines | Keeps (whenever possible) all the current paragraph lines on the same page (default value is false). |
| keepNext | Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false). |
| lineSpacing | 1 corresponds to single line spacing, 2 to double line spacing and so long so forth. It admits decimal numbers. |
| pageBreakBefore | If true forces a page break before the paragraph. |
| rtl | Set to true for right to left languages like Hebrew or Arabic. |
| smallCaps | If true displays text in small capital letters. |
| spacingBottom | Bottom padding in twentieths of a point |
| spacingTop | Top padding in twentieths of a point |
| textAlign | Text alignment within paragraphs. Possible values are: center, right, both and distribute. |
| textDirection | Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV. |
| underline | Underlines text. Possible values are: single, words, double, dotted, dash and wave. |
| widowControl | Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan). |
| wordWrap | Allows line breaking at character level (default value is false). |
stylesTOC
Path to a docx. This optional parameter allows to extract the TOC styles from an existing Word document so the embedded TOC can be fully customized.
