XML API - pdx:addShape

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addShape

Inserts different types of shapes into a Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addShape pdx:type="arc|curve|line|polyline|rect|roundrect|shape|oval" pdx:z-index="" pdx:wordFragmentName="">
        <pdx:width pdx:value="" />
        <pdx:height pdx:value="" />
        <pdx:position pdx:value="absolute|relative" />
        <pdx:margin pdx:marginTop="" pdx:marginLeft="" />
        <pdx:color pdx:strokecolor="" pdx:fillcolor="" />
        <pdx:strokeWidth pdx:value="" />
        <pdx:arc pdx:startAngle="" pdx:endAngle="" />
        <pdx:line pdx:from="" pdx:to="" pdx:control1="" pdx:control2="" />
        <pdx:curve pdx:from="" pdx:to="" pdx:control1="" pdx:control2="" />
        <pdx:polyline pdx:points="" />
        <pdx:roundrect pdx:arcsize="" />
        <pdx:shape pdx:path="" pdx:coordsize="" />
    </pdx:addShape>
</pdx:content>

This element inserts a shape into the Word document.

The available types include:

arcs of a circle (filled or not)
bezier curves (filled or not)
straight lines
polylines
rectangles
rectangles with rounded corners
arbitrary shapes (VML paths)
ovals

Attributes and sub-elements

type

arc, curve, line, polyline, rect, roundrect, shape, oval.

options

Key	Description
width	Shape width given in points.
height	Shape height given in points.
position	The possible values are: absolute, relative.
margin-top	The possible values are: absolute, relative.
margin-left	Left margin given in points.
z-index	Equivalent to the CSS z-index property. Choose a high positive number to make sure that the shape is over the text or a negative number if you want the shape to be behind the text.
strokecolor	The chosen line color in hexadecimal value: #ff0000, #00ffff.
strokeweight	The width of the line in points: 1.0 pt, 3.5 pt...
fillcolor	The chosen fill color in hexadecimal value: #ff0000, #00ffff.

Options for specific types:

Key	Description
arc
startAngle	The angle of the tangent line at the initial point of the arc.
endAngle	The angle of the tangent line at the final point of the arc.
line and curve
from	The x and y coordinates of the initial point in the format "x,y".
to	The x and y coordinates of the final point in the format "x,y".
control1	The final control point for the bezier curve (it does not apply for plain lines) in the format "x,y".
control2	The final control point for the bezier curve (it does not apply for plain lines) in the format "x,y".
roundrect
arcsize	A number describing the "roundness" of the rectangle corners: 0.5, 1.8".
shape
path	The VML path describing the shape. You need a working knowledge of the VML standard.
coordsize	The VML path describing the shape. You need a working knowledge of the VML standard.

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">Arc:</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addShape pdx:type="arc">
            <pdx:width pdx:value="70"/>
            <pdx:height pdx:value="70"/>
            <pdx:color pdx:strokecolor="#ff0000" pdx:fillcolor="#555555" />
            <pdx:strokeWidth pdx:value="4" />
            <pdx:arc pdx:startAngle="0" pdx:endAngle="210" />
        </pdx:addShape>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Curve:</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addShape pdx:type="curve">
            <pdx:color pdx:strokecolor="#ff0000" pdx:fillcolor="#555555" />
            <pdx:strokeWidth pdx:value="4" />
            <pdx:curve pdx:control1="60,70" pdx:control2="125,170" pdx:from="300,40" pdx:to="120,150"/>
        </pdx:addShape>
    </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: