XML API - pdx:deleteBlock

pdx:deleteBlock/h2>

Deletes a block of content from the Word template.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate=""> <pdx:deleteBlock 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$).

Please 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/phpdocx/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:deleteBlock 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>

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: