XML API - pdx:mergeDocx


Merges Word documents.


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


Element definition

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


The destination path of the merged file.


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

Key Description

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.

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




PHP code

The resulting Word document looks like: