XML API - pdx:removeTemplateVariable

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

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

content.xml

settings.xml

PHP code

The resulting Word document looks like: