createListStyle

WORD CONTENTS

LAYOUT & SETTINGS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

BULK PROCESSING

TRACKING

CRYPTOPHPDOCX

DIGITAL SIGNATURE

ARTIFICIAL INTELLIGENCE

XLSXUTILITIES

PPTXUTILITIES

BLOCKCHAIN

VARIANT

createListStyle

TRIAL / ADVANCED / PREMIUM

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

Description

public createListStyle ( string $name [, array $options[, array $listOverrideOptions]] )

This method allows to generate 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 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.

Parameters

name

A string with the name of the list you are creating. If used in combination with the embedHTML or replaceTemplateVariableByHTML methods the name given to the new custom list has to coincide with the list style name that you want to override.

options

The options array includes an array for each list level that you wish to customize.

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

listOverrideOptions

Array with the different styling options to override.

Key	Type	Description
listOptions	array	Same options than $options.
name	string	The name to give to the created override.

Exceptions

Image does not exists.

Image format is not supported.

Code samples

Example #1

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// custom options
$latinListOptions = array();
$latinListOptions[0]['type'] = 'lowerLetter';
$latinListOptions[0]['format'] = '%1.';
$latinListOptions[1]['type'] = 'lowerRoman';
$latinListOptions[1]['format'] = '%1.%2.';

// create the list style with name: latin
$docx->createListStyle('latin', $latinListOptions);

// list items
$myList = array('item 1', array('subitem 1.1', 'subitem 1.2'), 'item 2');

// insert custom list into the Word document
$docx->addList($myList, 'latin');

$docx->createDocx('output');

The resulting Word document looks like:

Example #2

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// custom Bullets
$latinListOptions = array();
$latinListOptions[0]['type'] = 'bullet';
$latinListOptions[0]['format'] = 'G';
$latinListOptions[0]['font'] = 'Wingdings';
$latinListOptions[1]['type'] = 'bullet';
$latinListOptions[1]['format'] = 'F';
$latinListOptions[1]['font'] = 'Wingdings';

// create the list style with name: latin
$docx->createListStyle('funnyBullets', $latinListOptions);

// list items
$myList = array('item 1', array('subitem 1.1', 'subitem 1.2'), 'item 2');

// insert custom list into the Word document
$docx->addList($myList, 'funnyBullets');

$docx->createDocx('output');

The resulting Word document looks like:

Example #3

require_once 'classes/CreateDocx.php';

$docx = new CreateDocx();

// custom options
$latinListOptions = array();
$latinListOptions[0]['type'] = 'bullet';
$latinListOptions[0]['image'] = array(
    'src' => 'image.png',
    'height' => 200,
    'width' => 300,
);

// create the list style with name: imagec
$docx->createListStyle('imagec', $latinListOptions);

// list items
$myList = array('item 1', 'item 2', array('subitem 1', 'subitem 2'), 'item 3');

// insert the custom list into the Word document
$docx->addList($myList, 'imagec');

$docx->createDocx('output');

The resulting Word document looks like:

Release notes

phpdocx 13.0:
- typeCustom option.

phpdocx 11.0:
- images as bullets (image option).
- suff option.

phpdocx 9.5:
- supported overwriting styles in level lists.

phpdocx 9.0:
- align and position options.

phpdocx 7.5:
- start option.