pdx:addPageBorders Adds custom page borders to the current Word document

pdx:addPageBorders

Adds custom page borders to the current Word document.

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>

​x
 
<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 except first).
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>

 
<?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>

 
<?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>

 
<?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>
​

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

 
import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()
​

var XmlDocx = require("wrappers/XmlDocx.js");

var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();

 
var XmlDocx = require("wrappers/XmlDocx.js");
​
var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();
​

using System;
using XmlDocx;

namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}

 
using System;
using XmlDocx;
​
namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}
​

import com.Xmldocx;

public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}

 
import com.Xmldocx;
​
public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}
​

require "wrappers/XmlDocx.rb"

document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render

 
require "wrappers/XmlDocx.rb"
​
document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render
​

#include "XmlDocx.h"

XmlDocxType doc;

char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";

init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);

 
#include "XmlDocx.h"
​
XmlDocxType doc;
​
char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";
​
init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);
​

The resulting Word document looks like: