| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
DynaPDF.DeleteWatermark
Delete a watermark template.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| DynaPDF | 13.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.DeleteWatermark"; PDF; PageNum { ; InclAnnots } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| The PDF reference returned from DynaPDF.New. | |||
| PageNum | Page number or -1 for all pages. | -1 | |
| InclAnnots | Delete watermark annotations too? Pass 1 to delete annotations or 0 to not. |
1 | Optional |
Result
Returns number or error.
Description
Delete a watermark template.The function can be used to delete watermarks from a single page or from the entire document if PageNum is set to -1. If InclAnnots is true, watermark annotations will be deleted too, if any.
A watermark in PDF terms is a regular template that has a ADBE_CompoundType property of type Watermark. Such templates can be created with the Watermark tool of Adobes Acrobat, or with DynaPDF, for example. See DynaPDF.MarkTemplateAsWatermark() for further information.
If the function succeeds the return value is the number of deleted watermarks. Note that deleted watermark annotations do not increment the return value. If the function fails, the return value is an error.
See also DeleteWatermark function in DynaPDF manual.
Examples
Delete watermark on page 5:
Set Variable [ $ResetAction; Value:MBS( "DynaPDF.DeleteWatermark"; $pdf; 5 ) ]
See also
Release notes
- Version 13.3
Blog Entries
Created 13th June 2023, last changed 27th August 2023
