XML API - pdx:addPermProtection

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addPermProtection

Adds editable regions of contents into the Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addPermProtection pdx:type="start|end" />
</pdx:content>

This method allows you to add editable regions of contents in the document.

Attributes and sub-elements

type

The possible values are: 'start', 'end'. Each editable region must have start and end tags.

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:output pdx:name="output" pdx:type="docx" />
        <!--<pdx:crypto>
            <pdx:protect pdx:password="phpdocx" pdx:src="/var/www/phpdocx/examples/XmlApi/Crypto/addPermProtection/output.docx" pdx:target="/var/www/phpdocx/examples/XmlApi/Crypto/addPermProtection/output_crypted.docx" />
        </pdx:crypto>-->
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Content protected.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addPermProtection pdx:type="start" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Content not protected.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addPermProtection pdx:type="end" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Content protected.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addPermProtection pdx:type="start" />
        <pdx:addList pdx:listType="1">
            <pdx:data pdx:type="list">
                <pdx:item>Line 1</pdx:item>
                <pdx:data pdx:type="list">
                    <pdx:item>Line A</pdx:item>
                    <pdx:item>Line B</pdx:item>
                    <pdx:item>Line C</pdx:item>
                </pdx:data>
                <pdx:item>Line 3</pdx:item>
                <pdx:item>Line 4</pdx:item>
                <pdx:item>Line 5</pdx:item>
            </pdx:data>
        </pdx:addList>
        <pdx:addPermProtection pdx:type="end" />
    </pdx:content>
</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: