JSON API - addTableContents

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addTableContents

PREMIUM

TRIAL / ADVANCED

Inserts a Table of Contents (TOC).

Note

You are reading the JSON API documentation. For the PHP API method please go to addTableContents.

JSON data

{
    "options": {
        "autoUpdate": boolean,
        "displayLevels": "string"
    },
    "legend": {
        /* check addText styles */
    }
}

Styles from addText can be used.

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	Defines the legend text and its style.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "Table of Contents",
                "optionsParagraph": {
                    "bold": true,
                    "fontSize": 14
                }
            }
        },
        {
            "action": "addTableContents",
            "data": {
                "options": {
                    "autoUpdate": true
                },
                "legend": {
                    "text": "Click here to update the TOC",
                    "color": "B70000",
                    "bold": true,
                    "fontSize": 12
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Chapter 1",
                "optionsParagraph": {
                    "pStyle": "Heading1PHPDOCX"
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Section",
                "optionsParagraph": {
                    "pStyle": "Heading2PHPDOCX"
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Another TOC entry",
                "optionsParagraph": {
                    "pStyle": "Heading3PHPDOCX"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.