XML API - pdx:addTextBox

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addTextBox

Inserts text boxes into the Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addTextBox pdx:border="" pdx:wordFragmentName="">
        <pdx:data pdx:dataId="" pdx:type="text">data</pdx:data>
        <pdx:height pdx:value="" />
        <pdx:width pdx:value="" />
        <pdx:align pdx:value="left|center|right" />
        <pdx:contentVerticalAlign pdx:value="top|center|bottom" />
        <pdx:fillColor pdx:value="" />
        <pdx:textWrap pdx:value="none|tight|square|through" />
        <pdx:borderColor pdx:value="" />
        <pdx:borderWidth pdx:value="" />
        <pdx:paddingBottom pdx:value="" />
        <pdx:paddingLeft pdx:value="" />
        <pdx:paddingTop pdx:value="" />
        <pdx:paddingRight pdx:value="" />
    </pdx:addTextBox>
</pdx:content>

This element allows the insertion of a text box into your Word document.

Attributes and sub-elements

content

It may be a:

Word fragment or text string

boxParameters

The possible keys and values are:

Key	Description
align	center, left, right.
border	Border width.
borderColor	Hexadecimal value (#ff0000, #0000ff).
borderWidth	value in points.
contentVerticalAlign	top (default), center or bottom.
fillcolor	Hexadecimal value (#ff0000, #0000ff).
height	Height in points or 'auto'.
textWrap	tight, square, through, none.
paddingBottom	Distance in cm.
paddingLeft	Distance in mm.
paddingRight	Distance in mm.
paddingTop	Distance in mm.
width	Width in points.

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:addTextBox>
            <pdx:data pdx:dataId="" pdx:type="text">Some text content for the textbox. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</pdx:data>
            <pdx:width pdx:value="240" />
            <pdx:align pdx:value="right" />
            <pdx:borderColor pdx:value="#B70000" />
            <pdx:borderWidth pdx:value="4" />
            <pdx:paddingLeft pdx:value="10" />
            <pdx:fillColor pdx:value="#DDDDDD" />
        </pdx:addTextBox>
    </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: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: