JSON API - addList

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addList

PREMIUM

TRIAL / ADVANCED

Inserts a list.

Note

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

JSON data

{
    "values": array,
    "styleType": number | string,
    "options": {
        "bold": boolean,
        "caps": boolean,
        "color": "string",
        "font": "string",
        "fontSize": number,
        "highlightColor": "string",
        "italic": boolean
        "numId": number,
        "outlineLvl": number,
        "pStyle": "string",
        "rtl": boolean,
        "smallCaps": boolean,
        "underline": "string",
        "useWordFragmentStyles": boolean
    }
}

Key	Description
values	Values to be added to the list.
styleType	0 (clear), 1 (inordinate) (default), 2 (numerical) or the name of the created list.
bold	If true the text will be shown in bold characters.
caps	If true displays text in capital letters.
color	Hexadecimal color value: 'FF0000', '000000'...
font	Font family: 'Arial', Calibri'...
fontSize	Font size in points.
highlightColor	Highlights the run of text. The available colors are: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none.
italic	If true displays the text in italics.
numId	Sets a numId value. Useful to generate a continue numbering.
outlineLvl	Heading level (1-9).
pStyle	Paragraph style to be used.
rtl	Sets to true for right to left languages like Hebrew or Arabic.
smallCaps	If true displays text in small capital letters.
underline	Underlines text. Possible values are: single, words, double, dotted, dash and wave.
useWordFragmentStyles	Use WordFragment paragraph styles.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addList",
            "data": {
                "values": ["Line 1", "Line 2", "Line 3", "Line 4", "Line 5"],
                "styleType": 1
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addList",
            "data": {
                "values": ["Line 1", ["Line A", "Line B", "Line C"], "Line 2", "Line 3", "Line 4", "Line 5"],
                "styleType": 2
            }
        }
    ]
}

Example #3

{
    "wordfragments": [
        {
            "name": "wf_text",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": [
                            { "text": "We insert some"},
                            { "text": " bold text", "bold": true }
                        ]
                    }
                }
            ]
        },
        {
            "name": "wf_html",
            "actions": [
                {
                    "action": "embedHTML",
                    "data": {
                        "html": "<i>Some HTML code</i> with a <a href=\"http://www.phpdocx.com\">link</a>"
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addList",
            "data": {
                "values": ["In this example we use a custom list (val = 5) that comes bundled with the default PHPdocX template.", ["wf_text", "Line B", "Line C"], "wf_html", "Line 3"],
                "styleType": 5
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.