← Powrót do listy dostępnych hook'ów Info |
---|
Jeśli masz problem ze zrozumieniem jak działają hook'i, sprawdź opis: Mechanizm hook'ów |
Panel |
---|
title | Podstawowe informacje |
---|
| Dostępny od: 1.0.X |
Panel |
---|
| Hook pełni funkcję umieszczania znaku wodnego na dokumencie w czasie jego wyświetlania. Jest on zaimplementowany na podstawie definicji hook'a systemowego ReadFileHookAdapter, który umożliwia zmianę strumienia binarnego wyświetlanego dokumentu z archiwum lub w podglądzie w procesie. Konfiguracja hook'a wstawiającego znak wodny jest określana w formacie JSON pod postacią listy i zarządzana jest przez wtyczkę PCM (Plugin Configuration Manager). |
Panel |
---|
title | Parametry konfiguracyjne |
---|
| Nazwa parametru | Od wersji | Nazwa parametru w konfiguracji JSON | Opis | Typ parametru | Uwagi i ograniczenia |
---|
Identyfikator klasy dokumentów | 1.0.X | documentClassId | Klasa dokumentów wskazuje dla których dokumentów mają być brane pod uwagę parametry wstawiania znaku wodnego. | Całkowity | | Typ | 1.0.X | type | Określa jakiego typu jest znak wodny.
| Tekstowy | Wartość | Znaczenie |
---|
BARCODE | Kod kreskowy |
| Format | 1.0.X | format | Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek). | Tekstowy | Wartość | Znaczenie |
---|
CODE_39 | Kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, pozwalający zapisać 43 różne znaki. Każdy ze znaków składa się z 9 elementów (słupki jasne i ciemne), z których 3 są znacząco szersze. Ten format pozwala na zakodowanie liczb, wielkich liter i znaków (-, ., (spacja), $, /, +, %, *). | CODE_93 | Kod kreskowy będący udoskonaleniem formatu CODE_39. Podobnie jak swój pierwowzór przechowuje 43 znaki alfanumeryczne, ale dodatkowo posiada 4 znaki sterujące (($), (%), (/), (+)). | CODE_128 | Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII. |
| Identyfikator indeksu | 1.0.X | indexId | Wskazuje na indeks, z którego jest pobierana wartość do zakodowania w znaku wodnym. | Całkowity | Wartość indeksu musi być typu tekstowego. | Szerokość znaku wodnego | 1.0.X | codeWidth | Definiuje szerokość znaku wodnego w pikselach. | Całkowity | | Wysokość znaku wodnego | 1.0.X | codeHeight | Definiuje długość znaku wodnego w pikselach. | Całkowity | | Umiejscowienie | 1.0.X | position | Pozycjonuje znak wodny w odpowiedniej części strony. Do wykorzystania jest 9 predefiniowanych pozycji. | Tekstowy | Wartość | Znaczenie |
---|
TOP_RIGHT | Górny prawy róg. | TOP_LEFT | Górny lewy róg. | BOTTOM_RIGHT | Dolny prawy róg. | BOTTOM_LEFT | Dolny lewy róg. | TOP | U góry na środku. | BOTTOM | Na dole na środku. | LEFT | Na środku po lewej stronie. | RIGHT | Na środku po prawej stronie. | CENTER | Na środku. |
| Margines | 1.0.X | margin | Definiuje odstęp znaku wodnego od określonej krawędzi strony w zależności od wartości parametru Umiejscowienie np. gdy wspomniany parametr ma wartość TOP, to margines odnosi się do górnej krawędzi strony dokumentu.
| Zmiennoprzecinkowy | | Przezroczystość | 1.0.X | opacity | Określa przezroczystość wstawianego znaku wodnego na stronach dokumentu. | Zmiennoprzecinkowy | Wartość z przedziału 0-1. | Uprawnienia | 1.0.X | permissions | Uprawnienia określające dla jakich zalogowanych użytkowników w systemie przy próbie otwarcia dokumentu zostanie uruchomiony hook. | Obiekt | Parametr opcjonalny, gdy nie jest uzupełniony to znak wodny widzą wszyscy. | groups | Wskazuje na grupy użytkowników systemowych. | Tablica tekstowa | |
|
Panel |
---|
title | Przykładowa konfiguracja |
---|
|  Info |
---|
title | Przykładowa konfiguracja JSON |
---|
| "type": "BARCODE", "format": "CODE_128", "groups": ["Users", "Administrators"] "type": "BARCODE", "format": "CODE_128", |
|
|