XML API - pdx:protectDocx

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:protectDocx

Password protects the contents of a Word document.

Note

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

Description

Element definition

<pdx:config>
    <pdx:crypto>
        <pdx:protect pdx:password="" pdx:type="" pdx:src="" pdx:target="" />
    </pdx:crypto>
</pdx:config>

This element allows to password protect a Word document. One may protect in read only mode or allow the final user to modify comments or form elements.

Notice that this element does not encrypt the contents of the Word document, only protects them from unauthorized modifications. This element is not secure and can be easily overridden by an experienced user.

Attributes and sub-elements

src

Path to the word document you want to protect.

target

Path to the resulting protected document.

password

The password should be a string of 15 or less characters. If you introduce a password with more than 15 characters it will be automatically truncated.

type

Available protection types: readOnly (allows no editing. This is the default value), comments (allows the edition of comments), trackedChanges (allows editing with revision tracking) and forms (allows the edition of form fields).

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/samples/files/Text.docx" pdx:target="/var/www/phpdocx/samples/Crypto/protectDocx/Protected.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: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: