XML API - pdx:importHeadersAndFooters

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:importHeadersAndFooters

Imports headers and footers from an external Word document.

Note

You are reading the XML API documentation. For the PHP API method please go to importHeadersAndFooters.

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 omitted 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
'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/phpdocx/samples/files/TemplateHeaderAndFooter.docx" pdx:type="headerAndFooter" />
    </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: