XML API - pdx:watermarkDocx

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:watermarkDocx

Inserts a watermark into a Word document.

Note

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

Description

Element definition

<pdx:utilities>
    <pdx:watermarkDocx pdx:src="" pdx:target="" pdx:type="image|text" pdx:section="">
        <pdx:imagePath pdx:imagePath="" />
        <pdx:height pdx:height="" />
        <pdx:option pdx:width="" />
        <pdx:decolorate pdx:decolorate="" />
        <pdx:gain pdx:gain="" />
        <pdx:blacklevel pdx:blacklevel="" />
        <pdx:remove_previous_watermarks pdx:remove_previous_watermarks="" />
        <pdx:text_orientation pdx:text_orientation="" />
        <pdx:font pdx:font="" />
        <pdx:color pdx:color="" />
        <pdx:opacity pdx:opacity="" />
        <pdx:scope pdx:value="header|footer" />
    </pdx:watermarkDocx>
</pdx:utilities>

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

Attributes and sub-elements

src

Path to the Word document.

target

Path to the resulting watermarked document.

type

Watermark type: 'text' or 'image'.

section

Section number.

options

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

If type is 'image':

Key	Description
image	Path to the watermark image.
height	Watermark image height in pixels (optional).
width	Watermark image width in pixels (optional).
decolorate	If true (default) decolorates the image.
gain	Optional value to customize decoloration: hexadecimal value.
blacklevel	Optional value to customize decoloration: hexadecimal value.
scope	Header (default) or footer.
remove_previous_watermarks	If true (default) removes previous watermarks.

If type is 'text':

Key	Description
text	The string of text used for watermarking.
text_orientation	Orientation: diagonal (default) or horizontal.
height	Watermark text height in pixels (optional).
width	Watermark text width in pixels (optional).
font	The font-family. If not set defaults to Calibri.
color	Hexadecimal value or color name (defaults to silver).
opacity	Decimal number between 0 and 1. If not set defaults to 0.5
scope	Header (default) or footer.
remove_previous_watermarks	If true (default) removes previous watermarks.

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:watermarkDocx pdx:source="/var/www/phpdocx/samples/files/Text.docx" pdx:target="/var/www/phpdocx/samples/DocxUtilities/watermarkDocx/output_watermarkDocx.docx" pdx:type="image">
            <pdx:image pdx:value="/var/www/phpdocx/samples/files/image.png" />
            <pdx:decolorate pdx:value="false" />
        </pdx:watermarkDocx>
    </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();

The resulting Word document looks like: