pdx:deleteTemplateBlock Deletes a block of content from the Word template

pdx:deleteTemplateBlock

Deletes a block of content from the Word template.

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
        <pdx:deleteTemplateBlock pdx:variableName="" />
</pdx:templateVariables>

The BLOCK variables are wrappers of content. They are used to remove unwanted parts of the document on “run time”.

This method does exactly that: removes a block of content from the Word template that has been previously enclosed between BLOCK tags ($BLOCK_varName$).

We refer to the Tutorial for a detailed description of the process.

Attributes and sub-elements

variableName

The name of the variable.

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/xmldocx/samples/files/TemplateBlocks.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:deleteTemplateBlocks pdx:variableName="FIRST" />
    </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>

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: