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

pdx:createListStyle

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

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:createListStyle>
</pdx:settings>

​x
 
<pdx:settings>
    <pdx:createListStyle pdx:name="">
        <pdx:item pdx:type="" pdx:font="" pdx:fontSize="" pdx:format="" pdx:hanging="" pdx:left="" pdx:start="" />
    </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 that the embedded HTML code uses the generated list style this has to 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 we are creating. If used in combination with the embedHTML or replaceTemplateVariableByHTML elemnts the neme given to the new custom list has to coincide with the list style name that we want to override.

options

key	Description
type	none bullet decimal upperRoman lowerRoman upperLetter lowerLater ordinal cardinalText ordinalText
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.
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>

 
<?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>

 
<?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>

 
<?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>
​

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

 
import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()
​

var XmlDocx = require("wrappers/XmlDocx.js");

var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();

 
var XmlDocx = require("wrappers/XmlDocx.js");
​
var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();
​

using System;
using XmlDocx;

namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}

 
using System;
using XmlDocx;
​
namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}
​

import com.Xmldocx;

public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}

 
import com.Xmldocx;
​
public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}
​

require "wrappers/XmlDocx.rb"

document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render

 
require "wrappers/XmlDocx.rb"
​
document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render
​

#include "XmlDocx.h"

XmlDocxType doc;

char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";

init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);

 
#include "XmlDocx.h"
​
XmlDocxType doc;
​
char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";
​
init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);
​

The resulting Word document looks like: