← Return to the list of hooks Available from version: 1.0.17
|
Hook places a watermark on the document as it is displayed. This hook is implemented based on the definition of the ReadFileHookAdapter system hook, which allows to change the binary stream of the displayed document from archive or in preview in the process. Configuration of the watermark insert hook is defined in JSON format as a list and is managed by the PCM (Plugin Configuration Manager). |
Parameter name | From version | Parameter name in JSON configuration | Description | Paremeter type | Comments and restrictions |
|---|
Document Class ID
| 1.0.17 | documentClassId | The document class indicates for which documents the watermark insertion parameters are to be considered. | Integer | | Type
| 1.0.17 | type | Specifies what type of watermark is. | Text | | Value | Meaning |
|---|
| BARCODE | Barcode |
| Format
| 1.0.17 | format | Specifies standard for one-dimensional barcodes (writing information on one line, in the form of dashes). | Text | | Value | Meaning |
|---|
| CODE_39 | Barcode with variable-length alphanumeric characters to store 43 different characters. Each sign consists of 9 elements (light and dark bars), 3 of which are significantly wider. This format allows you to encode numbers, capital letters and characters (-, ., (Space), $, /, +,%, *). | | CODE_93 | The barcode is an improvement of the CODE_39 format. Like its prototype, it stores 43 alphanumeric characters, but additionally has 4 control characters (($), (%), (/), (+)).
The code accepts only uppercase letters. | | CODE_128 | Variable length, high density alphanumeric code. It can encode characters from the entire ASCII range. |
| Index ID
| 1.0.17 | indexId | Indicates the index from which the value to be encoded in the watermark is taken. | Integer | The index value must be of the text type. | | Watermark width | 1.0.17 | codeWidth | Defines the width of the watermark in pixels. | Text | The parameter does not define the maximum width of the barcode - in the case when the substituted value turns out to be too long, the width will be automatically increased. | | Watermark height | 1.0.17 | codeHeight | Defines the height of the watermark in pixels. | Text | | | Position | 1.0.17 | position | Positions the watermark on the appropriate part of the page. There are 9 predefined positions to use. | Text | | Value | Meaning |
|---|
| TOP_RIGHT | Upper right corner | | TOP_LEFT | Upper left corner | | BOTTOM_RIGHT | Lower right corner | | BOTTOM_LEFT | Lower left corner | | TOP | Top middle | | BOTTOM | Bottom middle | | LEFT | Left middle | | RIGHT | Right middle | | CENTER | Middle |
| | Margin | 1.0.17 | margin | Defines the distance of the watermark from the specified edge of the page depending on the value of the Location parameter, e.g. when the mentioned parameter is TOP, the margin refers to the top edge of the document page. | Float | | | transparency | 1.0.17 | opacity | Specifies the transparency of the inserted watermark on the pages of the document. | Float | Value in the range 0-1. | | Permissions | 1.0.17 | permissions | Permissions defining for which users logged in to the system the hook will be run when trying to open a document. | Object | Optional parameter, when is not filled, everyone can see the watermark. | | groups | Indicates groups of system users. | Text table | |
|
"type": "BARCODE",
"format": "CODE_128", "groups": ["Users", "Administrators"] "type": "BARCODE",
"format": "CODE_128", |
|
|
