XML API - pdx:replaceVariableByWordFragment


Replaces placeholder variables by fragments of Word.


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


Element definition

This powerful element allows the substitution of placeholder variables by Word fragments that may include:

  • formatted text
  • tables
  • images
  • charts
  • footnotes
  • ...you name it!

This element offers you complete control over the contents of the generated Word document. Moreover it is fully compatible with the PDF conversion plugin.

Attributes and sub-elements


This must be an element with the name of the placeholder template variable and the WordFragment element that should replace it.


Key Description
firstMatch If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only replace the first ocurrence of the variable within the Word document.
target Possible values are: document (default), header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure.
replaceType Possible values are:
  • block (default): replaces the variable and removes its containing paragraph.
  • inline: only replaces the variable by the WordFragment inline content (it may be used to replace a variable by formatted text).
Code samples

Example #1




PHP code

The resulting Word document looks like: