XML API - pdx:mergeDocx

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:mergeDocx

Merges Word documents.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:mergeDocx pdx:mergeType="" pdx:numbering="" pdx:preserveStyleDefaults="" pdx:lineBreaks="" pdx:forceLatestStyles="" pdx:target="">
        <pdx:docx pdx:path="" />
        <pdx:docx pdx:path="" />
    </pdx:mergeDocx>
</pdx:utilities>

This element allows the full merging of DOCX documents.

styles
images
charts
lists
footnotes and endnotes
comments
sections with their corresponding headers and footers (optional)

Attributes and sub-elements

target

The destination path of the merged file.

options

The possible keys and values are (required options are shown with yellow background):

Key	Description
mergeType	The possible values are: 0: preserves the sections of the merged document with their respective headers and footers. 1: merges the contents at the end of the last section of the first document. If the mergeType equals 1 or the last section of the first document is of the "continuous" type, there may be some misalignment of absolutely positioned content in the merged document. This is due to the fact that the absolute positioned content of the second document was layed out with respect the second document page distribution that may change after the merging.
enforceSectionPageBreak	Enforces a page section break between documents even if the first section type of the merged document is of the continuous type.
numbering	The possible values are: continue (the numbering continues in the merged document). restart (the original numbering of the second document is preserved).
lineBreaks	Inserts the indicated number of line breaks between the contents of the merging files.
forceLatestStyles	The destination path of the merged file.

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:utilities>
        <pdx:mergeDocx pdx:mergeType="true" pdx:target="/var/www/phpdocx/samples/DocxUtilities/mergeDocx/output_merged.docx">
            <pdx:docx pdx:path="/var/www/phpdocx/samples/files/Text.docx" />
            <pdx:docx pdx:path="/var/www/phpdocx/samples/files/second.docx" />
            <pdx:docx pdx:path="/var/www/phpdocx/samples/files/SimpleExample.docx" />
        </pdx:mergeDocx>
    </pdx:utilities>
</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: