XML API - pdx:replacePlaceholderImage


Replaces a single variable within a list by a list of items.


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


Element definition

This element allows to replace a placeholder image that may be fully formatted in Word (border, shadows, effects...) by an image of our choice.

If one does not set the width, height and/or dpi options the element will use the corresponding data taken from the original placeholder image.

The placeholder image should be tagged using the alternate text option of your Word interface (this may depend on your Word version).

Attributes and sub-elements


The name of the variable that identifies the placeholder image.


The path to the image that you want to insert into the Word document.


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, header, footer, footnote, endnote or comment.
height The value in cm (float) or 'auto' (use image size).
width The value in cm (float) or 'auto' (use image size).
dpi Dots per inch. This parameter is only taken into account if width or height are set to auto.
Code samples

Example #1




PHP code

The resulting Word document looks like: