XML API - pdx:replacePlaceholderImage

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replacePlaceholderImage

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

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:replacePlaceholderImage pdx:name="" pdx:target="" pdx:firstMatch="" pdx:width="" pdx:height="" pdx:dpi="" pdx:path="" />
</pdx:templateVariables>

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

name

The name of the variable that identifies the placeholder image.

path

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

options

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

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:template pdx:path="/var/www/phpdocx/samples/files/placeholderImage.docx" />
        <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:templateVariables pdx:preprocessedTemplate="">
        <pdx:replacePlaceholderImage pdx:name="HEADERIMG" pdx:target="header" pdx:height="3" pdx:width="3" pdx:path="/var/www/phpdocx/samples/files/img/logo_header.jpg" />
        <pdx:replacePlaceholderImage pdx:name="LOGO" pdx:path="/var/www/phpdocx/samples/files/img/imageP3.png" />
    </pdx:templateVariables>
</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: