XML API - pdx:addImage

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addImage

Inserts an image into the Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addImage pdx:imageAlign="" pdx:dpi="" pdx:scaling="" pdx:width="" pdx:height="" pdx:wordFragmentName="" pdx:hyperlink="" pdx:relativeToHorizontal="margin|page|column|character|leftMargin|rightMargin|insideMargin|outsideMargin" pdx:relativeToVertical="margin|page|line|paragraph|topMargin|bottomMargin|insideMargin|outsideMargin" pdx:verticalAlign="top|center|bottom">
        <pdx:data pdx:dataId="" pdx:dataType="text">path to image</pdx:data>
        <pdx:imageSize pdx:sizeX="" pdx:sizeY="" />
        <pdx:imageBorder pdx:borderColor="" pdx:borderStyle="" pdx:borderWidth="" />
        <pdx:imageMargin pdx:spacingTop="" pdx:spacingRight="" pdx:spacingBottom="" pdx:spacingLeft="" />
        <pdx:imagePosition pdx:float="" pdx:horizontalOffset="" pdx:verticalOffset="" />
        <pdx:imageCaption pdx:showLabel="" pdx:alignCaption="" pdx:sizeCaption="" pdx:colorCaption="" pdx:lineSpacingCaption="" pdx:captionValue="" />
        <pdx:textWrap pdx:value="0|1|2|3|4" />
    </pdx:addImage>
</pdx:content>

You may use this element to insert images (jpg, gif or png) into your Word document.

You may easily control:

the embedding and positioning of the image within a complex paragraph.
the size (if not explicitely given, phpdocx tries to read the width and height from the image headers).
the dpi or dots per inch (by default they are taken from the image headers or set to 96 dpi).
the scale (default 100%).
the target: main document (default), headers or footers.

If one wishes to insert an image within a complex paragraph or a table one should use this element in combination with the addText or the addTable element.

Attributes and sub-elements

options

Key	Description
src	Path to the image that you want to insert into the Word document.
borderColor	Hexadecimal color: FF0000.
borderStyle	Possible values are: solid dot dash lgDash dashDot lgDashDot lgDashDotDot sysDash sysDot sysDashDot sysDashDotDot
borderWidth	Given in emus (1cm = 360000 emus).
dpi	Dots per inch.
float	(left, right, center) floating image. It only applies if textWrap is not inline (default value).
height	Image height in pixels.
horizontalOffset	Given in emus (1cm = 360000 emus). Only applies if there is the image is not floating.
hyperlink	Image link.
imageAlign	Image aligment: right, center...
imageCaption	Image caption options
relativeToHorizontal	margin (default), page, column, character, leftMargin, rightMargin, insideMargin, outsideMargin. Not compatible with inline text wrapping.
relativeToVertical	margin, page, line (default), paragraph, topMargin, bottomMargin, insideMargin, outsideMargin. Not compatible with inline text wrapping.
scaling	% of size: 50, 100.
spacingTop	Spacing top in pixels.
spacingBottom	Spacing bottom in pixels.
spacingLeft	Spacing left in pixels.
spacingRight	Spacing right in pixels.
target	document (default value), defaultHeader, firstHeader, evenHeader, defaultFooter, firstFooter, evenFooter, comment, endnote or footnote. One should use this parameter in conjunction with the "rawWordML" option to later insert the image in a header or footer.
textWrap	Text wrap: 0 (inline) 1 (square) 2 (front) 3 (back) 4 (top and bottom) 5 (clear)
verticalOffset	Given in emus (1cm = 360000 emus).
width	Image width in pixels.

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:content>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">In this first example we just add an image with a dashed border:</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addImage pdx:imageAlign="center" pdx:scaling="50">
            <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/phpdocx/samples/files/img/image.png</pdx:data>
            <pdx:imageBorder pdx:borderColor="FF0000" pdx:borderStyle="lgDash" pdx:borderWidth="6" />
            <pdx:imageMargin pdx:spacingTop="10" pdx:spacingRight="20" pdx:spacingBottom="0" pdx:spacingLeft="0" />
            <pdx:textWrap pdx:value="0" />
        </pdx:addImage>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is a closing paragraph.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
    </pdx:content>
</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: