XML API - pdx:removeTemplateVariable

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:removeTemplateVariable

Removes a phpdocx placeholder variable from the Word document.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:removeTemplateVariable pdx:removeType="inline|block" pdx:variableName="" pdx:target="" />
</pdx:templateVariables>

This element allows to remove an "unused" placeholder variable.

There are two options: just remove the placeholder variable ($type = 'inline') or remove the whole paragraph that contains it ($type = 'block').

Attributes and sub-elements

variableName

The name of the variable you want to remove.

removeType

It may be 'inline' if one wants just to remove the variable or 'block' (default value) if one wants also to remove the containing paragraph.

target

Possible values are: document (default value), header, footer, footnote, endnote or comment.

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/TemplateVariables.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:removeTemplateVariable pdx:removeType="block" pdx:variableName="FOOTERVAR" pdx:target="footer" />
        <pdx:removeTemplateVariable pdx:removeType="inline" pdx:variableName="OTHERVAR" />
        <pdx:removeTemplateVariable pdx:removeType="block" pdx:variableName="FOOTNOTEVAR" pdx:target="footnote" />
    </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: