pdx:protectPDF Password protects the contents of a PDF document

pdx:protectPDF

Password protects the contents of a PDF document.

Description

Element definition

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

​x
 
<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 PDF document. One may protect the PDF from being printed, copied, etcetera.

Notice that this element does not encrypt the contents of the PDF document. This element is not secure and can be easily overridden by an experienced user.

You may find a detailed description of this package in the Cryptophpdocx section of the API documentation.

Attributes and sub-elements

src

Path to the PDF document we want to protect.

target

Path to the resulting protected PDF document.

options

The possible keys and values are (required options are shown with yellow background):

key	Description
permissionsBlocked	print modify copy annot-forms fill-forms extract assemble print-high
passwordOwner	String to allow full access to the PDF file.

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="pdf" />
        <pdx:crypto>
            <pdx:protect pdx:password="xmldocx" pdx:src="/var/www/xmldocx/samples/files/Test.pdf" pdx:target="/var/www/xmldocx/samples/Crypto/protectPdf/Protected.pdf" pdx:type="print,annot-forms" />
        </pdx:crypto>
    </pdx:config>
</pdx:document>

 
<?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="pdf" />
        <pdx:crypto>
            <pdx:protect pdx:password="xmldocx" pdx:src="/var/www/xmldocx/samples/files/Test.pdf" pdx:target="/var/www/xmldocx/samples/Crypto/protectPdf/Protected.pdf" pdx:type="print,annot-forms" />
        </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>

 
<?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>

 
<?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()

 
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()
​

var XmlDocx = require("wrappers/XmlDocx.js");

var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();

 
var XmlDocx = require("wrappers/XmlDocx.js");
​
var document = new XmlDocx("config.xml");
document.setDocumentProperties("settings.xml");
document.addContent("content.xml");
document.setXmldocxPath("xmldocx path");
document.render();
​

using System;
using XmlDocx;

namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}

 
using System;
using XmlDocx;
​
namespace XmldocxSample
{
    public class Xmldocxtest
    {
        static void Main(string[] args)
        {
            Xmldocx docx = new Xmldocx('config.xml');
            docx.setDocumentProperties('settings.xml');
            docx.addContent('content.xml');
            docx.render();
        }
    }
}
​

import com.Xmldocx;

public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}

 
import com.Xmldocx;
​
public class Xmldocxtest
{
    public static void main(final String[] args) {
          
        XmlDocx docx = new XmlDocx('config.xml');
        docx.setDocumentProperties('settings.xml');
        docx.addContent('content.xml');
        docx.setXmldocxPath('xmldocx path');
        docx.render();
    }
}
​

require "wrappers/XmlDocx.rb"

document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render

 
require "wrappers/XmlDocx.rb"
​
document = XmlDocx.new("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render
​

#include "XmlDocx.h"

XmlDocxType doc;

char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";

init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);

 
#include "XmlDocx.h"
​
XmlDocxType doc;
​
char *config = "config.xml";
char *properties = "settings.xml";
char *content = "content.xml";
​
init(doc, "config.xml", 0);
addDocumentProperties(doc, "settings.xml");
addContent(doc, "content.xml");
setXmldocxPath(docx, "xmldocx path");
render(doc);
​

The resulting Word document looks like: