XML API - pdx:createCharacterStyle

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:createCharacterStyle

Creates a new Word character style.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:createCharacterStyle pdx:name="" >
        <pdx:characterStyle >
            <pdx:bold pdx:value="" />
            <pdx:caps pdx:value="" />
            <pdx:color pdx:value="" />
            <pdx:doubleStrikeThrough pdx:value="" />
            <pdx:em pdx:value="" />
            <pdx:font pdx:value="" />
            <pdx:fontSize pdx:value="" />
            <pdx:italic pdx:value="" />
            <pdx:position pdx:value="" />
            <pdx:rtl pdx:value="" />
            <pdx:smallCaps pdx:value="" />
            <pdx:strikeThrough pdx:value="" />
            <pdx:subscript pdx:value="" />
            <pdx:superscript pdx:value="" />
            <pdx:underline pdx:value="" />
            <pdx:vanish pdx:value="" />
        </pdx:characterStyle>
    </pdx:createCharacterStyle>
</pdx:settings>

This element allows the generation of custom character styles that may be later used in combination with, for example, the addText element.

Attributes and sub-elements

name

A string with the name of the Word style that you are creating.

styleOptions

Key	Description
bold	Bold text: 'on' or 'off'.
caps	Displays text in capital letters: 'on' or 'off'.
characterBorder	Adds a border to the character. Attributes and values: 'type' => none, single, double, dashed..., 'color' => ffffff, ff0000, 'spacing'=> 0, 1, 2..., 'width' => in eights of a point.
color	Hexadecimal color value: 'FF0000', '000000'...
doubleStrikeThrough	If true displays text in doubleStrikeThrough.
em	Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'.
font	Font family: 'Arial', Calibri'...
fontSize	Text size in points: 8, 9, 10...
italic	Italics: 'on' or 'off'.
position	Position value. Positive value for raised and negative value for lowered.
strikeThrough	If true displays text in strikethrough.
subscript	If true displays text in subscript.
superscript	If true displays text in superscript.
underline	Underlines text. Possible values are: 'single', 'words', 'double', 'dotted', 'dash' and 'wave'.
vanish	Uses a vanish style.

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:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">A text in red color with the character style</pdx:data>
                <pdx:textRunStyle>
                    <pdx:rStyle pdx:value="myStyle" />
                </pdx:textRunStyle>
            </pdx:textRun>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Other text set as bold but without the character style.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
    </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:createCharacterStyle pdx:name="myStyle" >
            <pdx:characterStyle>
                <pdx:bold pdx:value="true" />
                <pdx:color pdx:value="ff0000" />
                <pdx:font pdx:value="Arial" />
                <pdx:fontSize pdx:value="18" />
                <pdx:italic pdx:value="true" />
                <pdx:position pdx:value="6" />
                <pdx:underline pdx:value="single" />
            </pdx:characterStyle>
        </pdx:createCharacterStyle>
    </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: