XML API - pdx:createListStyle

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:createListStyle

Creates a custom list style to use it in combination with the addList and embedHTML methods.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:createListStyle pdx:name="">
        <pdx:item pdx:type="" pdx:font="" pdx:fontSize="" pdx:format="" pdx:hanging="" pdx:left="" pdx:start="" pdx:align="" pdx:position="" />
    </pdx:createListStyle>
</pdx:settings>

This element allows the generation of custom list styles that can be used in combination with the addList and embedHTML methods.

If you want the embedded HTML code to use the generated list style, this must have the same name as the corresponding CSS class for the UL tag. Do not forget to set the option 'customListStyles' to true in your call to embedHTML.

Attributes and sub-elements

name

The name of the list you are creating. If used in combination with the embedHTML or replaceVariableByHTML elements the name given to the new custom list has to coincide with the list style name that you want to override.

options

Key	Description
type	none bullet decimal upperRoman lowerRoman upperLetter lowerLater 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.
hanging	The extra space for the numbering, should be big enough to accommodate it, the default is 360.
italic	If true use italics.
left	The left indent. The default value is 720 times the list level.
position	Position value.
start	Start value. The default value is 1.
underline	Underlines. Possible values are: single, words, double, dotted, dash and wave.

Code samples

Example #1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:addList pdx:listType="latin">
            <pdx:data pdx:type="list">
                <pdx:item pdx:depth="1">item 1</pdx:item>
                <pdx:item pdx:depth="2">subitem 1.1</pdx:item>
                <pdx:item pdx:depth="2">subitem 1.2</pdx:item>
                <pdx:item pdx:depth="2">subitem 1.3</pdx:item>
                <pdx:item pdx:depth="1">item 2</pdx:item>
            </pdx:data>
        </pdx:addList>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document  xmlns:pdx="http://www.phpdocx.com/main" >
    <pdx:settings>
        <pdx:createListStyle pdx:name="latin">
            <pdx:item pdx:type="lowerLetter" pdx:format="%1." />
            <pdx:item pdx:type="lowerRoman" pdx:format="%1.%2." />
        </pdx:createListStyle>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: