XML API - pdx:addExternalFile

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addExternalFile

Inserts an external document (DOCX, HTML, RTF or MHT) into the current Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addExternalFile pdx:src="" pdx:matchSource="" pdx:preprocess="" pdx:firstMatch="" pdx:wordFragmentName="" />
</pdx:content>

This element allows the insertion of an external DOCX, HTML, RTF or MHT document within the current Word document.

When inserting a DOCX document, it is recommended that the page layout of the inserted DOCX coincides with the one of the Word document you are generating with phpdocx, if not you may expect certain formatting problems.

This element is not compatible with the conversion plugin: the inserted DOCX will not render at all in the resulting PDF, DOC, RTF, ODT or HTML document.

Attributes and sub-elements

options

key	Description
src	The path to the document (.docx) that you want to insert within our current Word document.
matchSource	If true (default value) tries to preserve as much as possible the styles of the DOCX to be included.
preprocess	If true does some preprocessing on the DOCX file to add.

Beware that the DOCX to insert gets modified so please make a backup copy first.

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">We are going to insert now a full Word document. Be aware that this method is not compatible with legacy versions of Word running the DOCX compatibility pack.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addExternalFile pdx:source="/var/www/phpdocx/samples/files/Text.docx" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">A new paragraph.</pdx:data>
            </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>

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: