XmlApi - pdx:addPageBorders

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addPageBorders

Adds custom page borders to the current Word document.

Note

You are reading the XMLAPI documentation. For the API method please go to addPageBorders.

Description

Element definition

<pdx:settings>
    <pdx:addPageBorders pdx:display="" pdx:color="" pdx:space="" pdx:style="" pdx:width="" pdx:offsetFrom="" pdx:zOrder="">
        <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:addPageBorders>
</pdx:settings>

This element allows you to insert page borders into the Word document.

Attributes and sub-elements

Key	Description
display	allPages (displays page border on all pages: default value). firstPage (displays page border on first page). notFirstPage (displays page border on all pages but the first one).
color	Border hexadecimal color ('000000' (default), 'FF0000'...).
offsetFrom	Possible values are: 'page' or 'text'.
space	Border spacing in points (default is 24).
style	Border. It can be none, single (default), double... See, for example, http://www.schemacentral.com/sc/ooxml/t-w_ST_Border.html for a complete list of border available styles.
width	Page border width in eigths of a point (default value is 4).
zOrder	Sets the z-index of the border.

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">This is just a chunk of text that we will repeat couple of times to fill up some space. This is just a chunk of text that we will repeat couple of times to fill up some space.</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Another chunk of text</pdx:data>
                <pdx:textRunStyle>
                </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:addPageBorders>
            <pdx:top pdx:color="FF0000" pdx:width="12" />
            <pdx:right pdx:width="12" />
            <pdx:bottom pdx:width="12" />
            <pdx:left pdx:width="12" />
        </pdx:addPageBorders>
    </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: