JSON API - createListStyle

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

createListStyle

PREMIUM

TRIAL / ADVANCED

Creates a list style.

Note

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

JSON data

{
    "name": "string",
    "listOptions": [
        {
            "type": "string",
            "align": "string",
            "bold": boolean,
            "color": "string",
            "font": "string",
            "fontSize": number,
            "format": "string",
            "hanging": number,
            "image": {
                "src": "string",
                "height": number,
                "width": number
            },
            "italic": boolean,
            "left": number,
            "numberingStyle": "string",
            "position": number,
            "start": number,
            "suff": "string",
            "typeCustom": "string",
            "underline": "string"
        }
    ],
    "listOverrideOptions": [
        "name": "string",
        "listOptions": []
    ]
}

Key	Description
name	The name of the list style.
type	none bullet decimal upperRoman lowerRoman upperLetter lowerLetter ordinal cardinalText ordinalText
align	"left", "center", "right".
bold	If true use bold characters.
color	Hexadecimal color value: "FF0000", "000000"...
font	Font family. This allows the customization of bullets.
fontSize	Font size in points.
format	The default one is "%1." for first level, "%2." for second level and so long so forth. Bullets don't use a string format value but symbols.
hanging	The extra space for the numbering, should be big enough to accommodate it, the default is 360.
image	Use an image as bullets. src => image path height => using pt width => using pt
italic	If true use italics.
left	The left indent. The default value is 720 times the list level.
numberingStyle	Numbering style.
position	Position value.
start	Start value. The default value is 1.
suff	Level suffix: tab, space or nothing.
typeCustom	Custom number format: "001, 002, 003, ..."... Requires setting the type option (decimal as default).
underline	Underlines. Possible values are: single, words, double, dotted, dash and wave.

Code samples

Example #1

{
    "actions": [
        {
            "action": "createListStyle",
            "data": {
                "name": "latin",
                "listOptions": [
                    {
                        "type": "lowerLetter",
                        "format": "%1."
                    },
                    {
                        "type": "lowerRoman",
                        "format": "%1.%2."
                    }
                ]
            }
        },
        {
            "action": "addList",
            "data": {
                "values": ["item 1", ["subitem 1.1", "subitem 1.2"], "item 2"],
                "styleType": "latin"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "createListStyle",
            "data": {
                "name": "myList",
                "listOptions": [
                    {
                        "type": "lowerLetter",
                        "format": "%1.",
                        "bold": true,
                        "color": "FF0000"
                    },
                    {
                        "type": "lowerRoman",
                        "format": "%1.%2.",
                        "bold": true,
                        "color": "00FF00",
                        "underline": "single"
                    }
                ]
            }
        },
        {
            "action": "addList",
            "data": {
                "values": ["item 1", ["subitem 1.1", "subitem 1.2"], "item 2"],
                "styleType": "myList"
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.