XML API - pdx:setTemplateBlockSymbol

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:setTemplateBlockSymbol

Sets the string used to identify block variables within a given template.

Note

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

Description

Element definition

<pdx:templateVariables pdx:preprocessedTemplate="">
    <pdx:setTemplateBlockSymbol pdx:symbolValue="" />
</pdx:templateVariables>

By default the phpdocx template variables have to begin by 'BLOCK_'.

You can change that string by any other you wish with the help of this method.

Attributes and sub-elements

symbolValue

The string you want to use for identifying block variables within templates..

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/TemplateBlocksCustomSymbol.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:setTemplateBlockSymbol pdx:symbolValue="MYBLOCK" />
        <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();