showWatermarkImage

(mPDF ≥ 2.2)

Description

boolean showWatermarkImage

Specifies whether or not to show/print the watermark image on each page. The file for the watermark must be defined using SetWatermarkImage(). The watermark is added to the document at the end of each page.

Values

$showWatermarkImage = true|false

If $showWatermarkImage is true or 1 the watermark image will be added to each page of the document.

The value can be changed during the document to turn the watermark on and off on different pages.

Values

• true: Show/print the watermark image
• false: Do not show/print the watermark image

Default: false

Values of 1 or 0 can also be used

Changelog

Examples

Example #1

<?php
$mpdf = new \Mpdf\Mpdf();

$mpdf->SetWatermarkImage('images/tiger.jpg');
$mpdf->showWatermarkImage = true;

$mpdf->WriteHTML('
Hello World
');

// As showWatermark is true when the first page is finished, a watermark is added
$mpdf->AddPage();

// When the second page is finished the watermark will not appear.
$mpdf->showWatermarkImage = false;

$mpdf->WriteHTML('
Hello World
');

See Also

• SetWatermarkText() - Set the text to use as a Watermark
• SetWatermarkImage() - Set an image to use as a Watermark
• watermarkImageAlpha - Specifies the transparency (alpha value) for the watermark image
• watermarkTextAlpha - Specifies the transparency (alpha value) for the watermark text
• showWatermarkText - Specifies whether or not to show/print the watermark text
• watermark_font - Specifies the font to use for Watermark text