pdx:addBackgroundImage Inserts a background image into the Word document

pdx:addBackgroundImage

Inserts a background image into the Word document.

Description

Element definition

<pdx:settings>
    <pdx:addBackgroundImage pdx:src="" />
</pdx:settings>

This element allows for the insertion of a background image into a Word document.

The image can have the following extensions:

jpg or jpeg,
png,
gif
bmp

A background image does not behaves exactly like a watermark but like a standard HTML background image: tiles the entire background.

Attributes and sub-elements

key	Description
src	File path

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">Please, use a discrete background image so the text is easily readable.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This one is pretty annoying but it illustrates well the functionality :-)</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                    <pdx:font pdx:value="Arial" />
                </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:addBackgroundImage pdx:src="/var/www/xmldocx/samples/files/image.png" />
    </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()

The resulting Word document looks like: