XML API - pdx:replaceVariableByWordFragment

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceVariableByWordFragment

Replaces placeholder variables by fragments of Word.

Note

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

Description

Element definition

<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:templateVariables pdx:preprocessedTemplate="">
        <pdx:replaceVariableByWordFragment pdx:replaceType="inline|block" pdx:target="" pdx:firstMatch="" pdx:parseLineBreaks="">
            <pdx:variable pdx:name="" pdx:wordFragmentName="" />
            <pdx:variable pdx:name="" pdx:wordFragmentName="" />
        </pdx:replaceVariableByWordFragment>
    </pdx:templateVariables>
</pdx:document>

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

variable

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

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 (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

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/TemplateWordFragment_1.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:content>
        <pdx:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="imageFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addImage pdx:scaling="50">
                        <pdx:data pdx:dataId="" pdx:dataType="text">/var/www/phpdocx/samples/files/img/image.png</pdx:data>
                        <pdx:textWrap pdx:value="1" />
                        <pdx:imagePosition pdx:float="right" />
                    </pdx:addImage>
                </pdx:content>
            </pdx:wordFragment>
            <pdx:wordFragment pdx:wordFragmentName="linkFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addLink>
                        <pdx:linkText>
                            <pdx:data pdx:dataId="" pdx:dataType="text">Link to Google</pdx:data>
                        </pdx:linkText>
                        <pdx:linkURL>
                            <pdx:data pdx:dataId="" pdx:type="URL">http://www.google.es</pdx:data>
                        </pdx:linkURL>
                        <pdx:paragraphStyle>
                            <pdx:color pdx:value="0000FF" />
                            <pdx:underline pdx:value="single" />
                        </pdx:paragraphStyle>
                    </pdx:addLink>
                </pdx:content>
            </pdx:wordFragment>
            <pdx:wordFragment pdx:wordFragmentName="footnoteFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addFootnote>
                        <pdx:textDocument>
                            <pdx:data pdx:dataId="" pdx:dataType="text">here it is</pdx:data>
                            <pdx:paragraphStyle />
                        </pdx:textDocument>
                        <pdx:textFootnote>
                            <pdx:data pdx:dataId="" pdx:dataType="text">This is the footnote text.</pdx:data>
                        </pdx:textFootnote>
                    </pdx:addFootnote>
                </pdx:content>
            </pdx:wordFragment>
            <pdx:wordFragment pdx:wordFragmentName="textFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addText>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="wordFragment">imageFragment</pdx:data>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="text">I am going to write a link: </pdx:data>
                            <pdx:textRunStyle>
                                <pdx:bold pdx:value="true" />
                            </pdx:textRunStyle>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="wordFragment">linkFragment</pdx:data>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="text"> to illustrate how to include links. </pdx:data>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="text">As you may see, it is extremely simple to do so and can be done with any other Word element. For example to include a footnote is also as simple as this: </pdx:data>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="wordFragment">footnoteFragment</pdx:data>
                        </pdx:textRun>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="text"> , as you see there is a footnote at the bottom of the page. </pdx:data>
                            <pdx:textRunStyle>
                                <pdx:color pdx:value="B70000" />
                            </pdx:textRunStyle>
                        </pdx:textRun>
                    </pdx:addText>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
    </pdx:content>
    <pdx:templateVariables pdx:preprocessedTemplate="">
        <pdx:replaceVariableByWordFragment pdx:replaceType="block">
            <pdx:variable pdx:name="WORDFRAGMENT" pdx:wordFragmentName="textFragment" />
        </pdx:replaceVariableByWordFragment>
    </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: