XML API - pdx:watermarkPdf

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:watermarkPdf

Inserts a watermark into a PDF document.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:watermarkPdf pdx:src="" pdx:target="" pdx:type="image|text" pdx:annotations="">
        <pdx:positionX pdx:value="" />
        <pdx:positionY pdx:value="" />
        <pdx:opacity pdx:value="" />
        <pdx:font pdx:value="" />
        <pdx:size pdx:value="" />
        <pdx:rotation pdx:value="" />
    </pdx:watermarkPdf>
</pdx:utilities>

This element allows you to insert a watermark image or text in a PDF document.

Attributes and sub-elements

src

Path to the PDF document.

target

Path to the resulting watermarked document.

type

Watermark type: 'text' or 'image'.

options

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

key	Description
annotations	Import annotations (links, comments and others).

If type is 'image':

Key	Description
image	Path to the watermark image.
positionX	X-asis position (page center as default).
positionY	Y-asis position (page center as default).
opacity	Decimal number between 0 and 1(optional), if not set defaults to 0.5.

If type is 'text':

Key	Description
text	The string of text used for watermarking.
positionX	X-asis position (page center as default).
positionY	Y-asis position (page center as default).
opacity	Decimal number between 0 and 1(optional), if not set defaults to 0.5.
font	The font-family. It must be installed in the OS.
size	Font size.

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:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:utilities>
        <pdx:watermarkPdf pdx:source="/var/www/phpdocx/examples/XmlApi/files/Test.pdf" pdx:target="/var/www/phpdocx/examples/XmlApi/DocxUtilities/watermarkPdf/output_watermarkPdf.pdf" pdx:type="image">
            <pdx:image pdx:value="/var/www/phpdocx/examples/XmlApi/files/image.png" />
        </pdx:watermarkPdf>
    </pdx:utilities>
</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();