PDFWatermark is one of the PDF Builder objects and is derived from PDFModel. It sets or gets watermark for a PDF document.
To view the full hierarchy of the PDF Builder objects, find "pdfobject" in the Browser, right-click the object, and then select "Show Hierarchy” in the pop-up menu.
-
You can only add one watermark, and only add one type of watermark (image or text) to a PDF document.
-
It is unsupported to add watermark to PDF 2.0, PDF/A, PDF/UA, PDF/X, or PDF/VT documents.
-
PDFWatermark does not support SVG images.
PDFWatermark provides the following properties. In addition, it inherits the properties from its parent, PDFModel.
|
PDFWatermark property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
PDFImage |
Sets or gets an image watermark. |
|
|
Real |
Sets or gets the transparency of the watermark. The unit is percentage. If the value is 100, it means that the watermark is transparent. If the value is 0, it means that the watermark is opaque. |
|
|
Real |
Sets or gets the rotation angle of the watermark. |
|
|
Real |
Sets or gets the scale of the watermark. A value of 0 or <0 means no scaling (the original size). A value of 100 (percentage) means scaling the watermark (text or image) until it fits just inside the borders of the current page. A value of 0~100 or >100 means the percentage of scaling based on the size of the watermark shown at the value of 100. |
|
|
PDFText |
Sets or gets a text watermark. |
|
PDFWatermark event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFWatermark provides the following functions.
|
PDFWatermark function |
Datatype returned |
Description |
|---|---|---|
|
String |
Returns the name assigned to the object. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
