XmlApi - pdx:replaceWordContent

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:replaceWordContent

Replaces an existing content by a WordFragment.

Note

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

Description

Element definition

<pdx:content>
    <pdx:replaceWordContent pdx:wordFragmentName="" pdx:location="" pdx:forceAppend="">
        <pdx:referenceNode pdx:type="" pdx:contains="" pdx:occurrence="" pdx:parent="" pdx:customQuery="" pdx:referencePositions="" pdx:referenceSections="" pdx:referenceTypes="" pdx:target="document|header|footer" />
        <pdx:attribute pdx:dataTag="" pdx:dataAttribute="" pdx:dataValue="" />
    </pdx:replaceWordContent>
</pdx:content>

Attributes and sub-elements

wordFragment

WordFragment to be inserted.

referenceNode

An array to get the refence node.
The possible keys and values of this array are:

Key	Description
type	* (all, default value), break, chart, endnote (content reference, the whole paragraph is removed), footnote (content reference, the whole paragraph is removed), image, paragraph (also for bookmarks, links and lists), section, shape, table.
contains	Contains a text string.
occurrence	Exact occurrence or range of contents (e.g.: 2..9, 2.., ..9) (string) or first() or last(). If empty iterate all elements.
attribute	Contains a specific attribute key and value.
parent	Main document body as default, allows to set any parent or a specific one. w:body (default), '/' (any parent) or any other specific parent (/w:tbl/, /w:tc/, /w:r/...).
target	Target content: document, header, footer.
referencePositions	Based on the sectPr contents order.
referenceSections	Section number.
referenceTypes	Header/footer type: first, even, default.
customQuery	Custom xpath query, overwrites any other reference.

location

After (default), before, inlineBefore or inlineAfter. Inline locations don't create a new w:p and add the WordFragment before or after the referenceNode (only inline elements).

forceAppend

If true appends the WordFragment if the reference node could not be found (false as default).

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:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="textFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addText>
                        <pdx:textRun>
                            <pdx:data pdx:dataId="" pdx:dataType="text">New text.</pdx:data>
                            <pdx:textRunStyle>
                                <pdx:color pdx:value="#0000ff" />
                                <pdx:fontSize pdx:value="20" />
                            </pdx:textRunStyle>
                        </pdx:textRun>
                    </pdx:addText>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:replaceWordContent pdx:wordFragmentName="textFragment">
            <pdx:referenceNode pdx:type="paragraph" pdx:contains="Lorem" />
        </pdx:replaceWordContent>
    </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();