pdx:addHeader Inserts headers into the Word document

pdx:addHeader

Inserts headers into the Word document.

Description

Element definition

<pdx:content>
    <pdx:addHeader>
        <pdx:default pdx:wordFragmentName="" />
        <pdx:even pdx:wordFragmentName="" />
        <pdx:first pdx:wordFragmentName="" />
    </pdx:addHeader>
</pdx:content>

It is possible to include different headers for:

the first page or title page,
even pages and
odd pages (this one is the default header for the whole document if no different headers are defined for the first or even pages).

The contents of the different headers are defined via the use of WordFragments. These header WordFragments allow the insertion of:

text paragraphs,
current date and/or hour,
images,
links,
lists,
page numbers,
shapes,
tables
and HTML content.

You may also import the headers of an existing docx document via the ImportHeadersAndFooters method.

Attributes and sub-elements

headers

key	Description
default	The WordML fragment object containing the contents for the default (odd pages) header
even	The WordML fragment object containing the contents for the even pages header
first	The WordML fragment object containing the contents for the first (title) page header

Code samples

#Example 1

config.xml

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="textFragment" pdx:target="defaultHeader">
                <pdx:content>
                    <pdx:addImage pdx:dpi="300">
                        <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/xmldocx/samples/files/img/image.png</pdx:data>
                    </pdx:addImage>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addHeader>
            <pdx:default pdx:wordFragmentName="textFragment" />
        </pdx:addHeader>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This document has a header with just one image.</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: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: