pdx:importHeadersAndFooters Modifies the general Word settings

pdx:importHeadersAndFooters

Imports headers and footers from an external Word document.

Description

Element definition

<pdx:settings>
    <pdx:importHeadersAndFooters pdx:src="" pdx:type="header|footer|headerAndFooter" />
</pdx:settings>

This element allows the insertion of Headers and Footers from an external Word document in the current Word document.

If the type parameter is ommitted both headers and footers are imported.

Attributes and sub-elements

src

The path to the external Word document.

type

The options are:.

'headerAndFooter' to import both header and footer (default value),
'header' for just the header or,
'footer' for just the footer.

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 the resulting word document with imported header and footer.</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:importHeadersAndFooters pdx:src="/var/www/xmldocx/samples/files/TemplateHeaderAndFooter.docx" pdx:type="headerAndFooter" />
    </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: