XML API - pdx:createParagraphStyle

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:createParagraphStyle

Creates a new Word paragraph style.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:createParagraphStyle pdx:name="" >
        <pdx:paragraphStyle >
            <pdx:backgroundColor pdx:value="" />
            <pdx:bidi pdx:value="" />
            <pdx:bold pdx:value="" />
            <pdx:border pdx:color="" pdx:space="" pdx:style="" pdx:width="">
                <pdx:top pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:right pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:bottom pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
                <pdx:left pdx:color="" pdx:space="" pdx:style="" pdx:width="" />
            </pdx:border>
            <pdx:caps pdx:value="" />
            <pdx:color pdx:value="" />
            <pdx:contextualSpacing pdx:value="" />
            <pdx:firstLineIndent pdx:value="" />
            <pdx:font pdx:value="" />
            <pdx:fontSize pdx:value="" />
            <pdx:hanging pdx:value="" />
            <pdx:headingLevel pdx:value="" />
            <pdx:italic pdx:value="" />
            <pdx:indentLeft pdx:value="" />
            <pdx:indentRight pdx:value="" />
            <pdx:keepLines pdx:value="" />
            <pdx:keepNext pdx:value="" />
            <pdx:LineSpacing pdx:value="" />
            <pdx:pageBreakBefore pdx:value="" />
            <pdx:pStyle pdx:value="" />
            <pdx:rtl pdx:value="" />
            <pdx:smallCaps pdx:value="" />
            <pdx:spacingBottom pdx:value="" />
            <pdx:spacingTop pdx:value="" />
            <pdx:tabPositions>
                <pdx:tabPosition pdx:type="" pdx:leader="" pdx:position="" />
                <pdx:tabPosition pdx:type="" pdx:leader="" pdx:position="" />
            </pdx:tabPositions>
            <pdx:textAlign pdx:value="center|right|both|distribute" />
            <pdx:textDirection pdx:value="" />
            <pdx:underline pdx:value="" />
            <pdx:widowControl pdx:value="" />
            <pdx:wordWrap pdx:value="" />
        </pdx:paragraphStyle>
    </pdx:createParagraphStyle>
</pdx:settings>

This element allows the generation of custom paragraph 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

If there is a tab and the tabPositions array is not defined the standard tab position (default of 708) will be used.

Key	Description
bold	Bold text: 'on' or 'off'.
border	Hexadecimal color value: 'FF0000', '000000'...
caps	Displays text in capital letters: 'on' or 'off'.
color	Hexadecimal color value: 'FF0000', '000000'...
contextualSpacing	Ignores spacing above and below when using identical styles: 'on' or 'off' (default).
doubleStrikeThrough	If true displays text in doubleStrikeThrough.
font	Font family: 'Arial', Calibri'...
fontSize	Text size in points: 8, 9, 10...
hanging	Paragraph hanging in twentieths of a point (twips).
italic	Italics: 'on' or 'off'.
indentLeft	Left margin in twips (twentieths of a point).
indentRight	Right margin in twips (twentieths of a point).
indentFirstLine	Extra indent for the first line of the paragraph.
jc	Text alignment. Possible values are: 'center', 'right', 'both', 'distribute'.
keepLines	Keeps (whenever possible) all the current paragraph lines on the same page: 'on' or 'off' (default).
keepNext	Keeps (whenever possible) in the same page the current paragraph with next paragraph: 'on' or 'off' (default).
lineSpacing	Separation between lines: 240 (single spacing), 480 (double spacing) and so long so forth.
outlineLvl	Heading level (1-9).
pageBreakBefore	Forces a page break before the paragraph. 'on' or 'off'.
position	Position value. Positive value for raised and negative value for lowered.
scaling	Scaling value, 100 is the default value.
spacingBottom	Bottom padding in twentieths of a point.
spacingTop	Top padding in twentieths of a point.
smallCaps	Displays text in small capital letters: 'on' or 'off'.
strikeThrough	If true displays text in strikethrough.
tabPositions	Each entry is an associative array with the following keys and values: 'type' (string) can be clear, left (default), center, right, decimal, bar and num. 'leader' (string) can be none (default), dot, hyphen, underscore, heavy and middleDot. 'position' (int) given in twentieths of a point.
textDirection	Text flow: lrTb, tbRl, btLr, lrTbV, tbRlV, tbLrV.
underline	Underlines text. Possible values are: 'single', 'words', 'double', 'dotted', 'dash' and 'wave'.
underlineColor	Underlines text with a color: 'FF0000', '000000'...
vanish	Uses a vanish style.
widowControl	Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan): 'on' or 'off'.
wordWrap	Allows line breaking at character level: 'on' or 'off' (default).

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 paragraph in grey color with borders. All borders are red but the right one that is blue. The general border style is single but the left border that is double. The top border is also thicker. We also include big left indentation.</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
                <pdx:paragraphStyle>
                    <pdx:pStyle pdx:value="myStyle" />
                </pdx:paragraphStyle>
            </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:createParagraphStyle pdx:name="myStyle" >
            <pdx:paragraphStyle>
                <pdx:border pdx:color="990000" pdx:style="single" pdx:width="12">
                    <pdx:top pdx:width="24" />
                    <pdx:right pdx:color="000099" />
                    <pdx:left pdx:style="double" />
                </pdx:border>
                <pdx:color pdx:value="0000ff" />
                <pdx:indentRight pdx:value="200" />
            </pdx:paragraphStyle>
        </pdx:createParagraphStyle>
    </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: