Versions Compared

Old Version 7

changes.mady.by.user Kamil Rogowski

Saved on

compared with

New Version 8

changes.mady.by.user Kamil Rogowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Polish

← 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
titlePodstawowe informacje

Dostępny od: 1.0.0

Panel
titleOpis

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). Znak wodny jest umieszczany na każdej stronie dokumentu.

Panel
titleParametry konfiguracyjne
Nazwa parametru w konfiguracji JSONOd wersjiOpisTyp parametruUwagi i ograniczenia
documentClass*1.0.0Nazwa Klasy dokumentów wskazuje dla których dokumentów ma być uruchamiany mechanizm wstawiania znaku wodnego.Tekstowy

 

watermark

type*

1.0.0Określa typ znaku wodnego.
Tekstowy
WartośćZnaczenie
BARCODEkoduje wartość parametru text do postaci kodu kreskowego o określonym formacie zdefiniowanym w parametrze format. Znak wodny umieszczany na dokumencie jest kodem kreskowym.
TEXTWartość parametru text jest nanoszona na dokument jako znak wodny w formie jawnej, niezakodowanej.

watermark

text*

1.0.0

Przyjmuje wartość tekstową, która jest wykorzystywana do utworzenia znaku wodnego. W celu skorzystania z wartości indeksów dokumentu należy umieścić nazwę indeksu w nawiasach klamrowych {}. Istnieje możliwość wykorzystania więcej niż jednej wartości indeksu w parametrze. Każdy kolejny indeks musi być opatrzony nawiasami klamrowymi.

Przykład.

"Numer sprawy: {Numer sprawy}, Data rejestracji: {Data rejestracji}"

->

"Numer sprawy: 433589, Data rejestracji: 13-02-2021"

Tekstowy
Warning

Wszystkie wpisane nazwy indeksów w ciągu tekstowym muszą istnieć w klasie dokumentów podanej w parametrze documentClass. Jeśli przeglądany dokument nie zawiera wartości indeksu (jest pusty), którego nazwa została podana w tym parametrze w nawiasach klamrowych, to nazwa zostanie zastąpiona pustym łańcuchem znaków "".

 

 

 

 

 

watermark

positionX%*

1.0.0Wskazuje pozycję procentową X (w poziomie) znaku wodnego względem wymiarów strony dokumentu.CałkowityPozycja liczona od lewej krawędzi (0%) do prawej krawędzi strony (100%).

watermark

positionY%*

1.0.0Wskazuje pozycję procentową Y (w pionie) znaku wodnego względem wymiarów strony dokumentu.CałkowityPozycja liczona od górnej krawędzi (0%) do dolnej krawędzi strony (100%).

watermark

opacity*

1.0.0Określa przezroczystość wstawianego znaku wodnego.ZmiennoprzecinkowyWartość z przedziału 0.0 - 1.0.

watermark

alignment*

1.0.0Określa pozycję znaku wodnego względem odpowiedniego rogu znaku wodnego.Tekstowy
WartośćZnaczenie
BOTTOM_LEFT

Pozycja znaku wodnego względem lewego dolnego rogu znaku wodnego.

 

watermark

watermarkBarcode

format

1.0.0Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek).Tekstowy
WartośćZnaczenie
CODE_39

Jednowymiarowy kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, w którym występują paski o dwóch różnych szerokościach. Do kodowania CODE_39 używane są 43 znaki plus dodatkowe znaki, które są ogranicznikami i znakami start/stop. Znak start/stop zawsze występuje jako pierwszy i ostatni znak kodu i jest nim znak '*'. Ten format nie pozwala na zakodowanie małych liter.

Znak
Wartość
Znak
Wartość
Znak
Wartość
Znak
Wartość
0
0
B
11
M
22
X
33
1
1
C
12
N
23
Y
34
2
2
D
13
O
24
Z
35
3
3
E
14
P
25
-
36
4
4
F
15
Q
26
.
37
5
5
G
16
R
27
space
38
6
6
H
17
S
28
$
39
7
7
I
18
T
29
/
40
8
8
J
19
U
30
+
41
9
9
K
20
V
31
%
42
A
10
L
21
W
32
  

 

CODE_93

Jednowymiarowy kod kreskowy będący udoskonaleniem formatu CODE_39. Występują w nim paski o czterech różnych szerokościach. Podobnie jak swój pierwowzór przechowuje 43 znaki alfanumeryczne, ale dodatkowo posiada 4 znaki sterujące (($), (%), (/), (+)), które są używane do kodowania wszystkich 128 znaków ASCII (CODE_93 Extended). Kod przyjmuje wyłącznie wielkie litery, chyba że zostaną użyte znaki sterujące.

Znak
Wartość
Znak
Wartość
Znak
Wartość
Znak
Wartość
0
0
C
12
O
24
-
36
1
1
D
13
P
25
.
37
2
2
E
14
Q
26
space
38
3
3
F
15
R
27
$
39
4
4
G
16
S
28
/
40
5
5
H
17
T
29
+
41
6
6
I
18
U
30
%
42
7
7
J
19
V
31
($)
43
8
8
K
20
W
32
(%)
44
9
9
L
21
X
33
(/)
45
A
10
M
22
Y
34
(+)
46
B
11
N
23
Z
35
  

Code 93

 

CODE_128

Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII.

watermark

watermarkBarcode

codeWidth

1.0.0Definiuje szerokość kodu kreskowego w pikselach.CałkowityParametr nie definiuje maksymalnej szerokości kodu kreskowego - w przypadku, gdy podstawiana wartość okaże się zbyt długa, szerokość automatycznie zostanie zwiększona.

watermark

watermarkBarcode

codeHeight

1.0.0Definiuje wysokość kodu kreskowego w pikselach.Całkowity 

watermark

watermarkText

size

1.0.0Rozmiar tekstu.Zmiennoprzecinkowy 

watermark

watermarkText

color

1.0.0Kolor tekstu.Tekstowy
WartośćZnaczenie
WHITEBiały
LIGHT_GRAYJasnoszary
GRAYSzary
DARK_GRAYCiemnoszary
BLACKCzarny
REDCzerwony
PINKRóżowy
ORANGEPomarańczowy
YELLOWŻółty
GREENZielony
MAGENTAMagenta
CYANCyjan
BLUENiebieski

watermark

watermarkText

fontType

1.0.0Rodzaj czcionki tekstu.Tekstowy
WartośćZnaczenie
COURIERCourier
COURIER_BOLDCourier Bold
COURIER_OBLIQUECourier Oblique
COURIER_BOLDOBLIQUECourier Bold Oblique
HELVETICAHelvetica
HELVETICA_BOLDHelvetica Bold
HELVETICA_OBLIQUEHelvetica Oblique
HELVETICA_BOLDOBLIQUEHelvetica Bold Oblique
SYMBOLSymbol
TIMES_ROMANTimes Roman
TIMES_BOLDTimes Bold
TIMES_ITALICTimes Italic
TIMES_BOLDITALICTimes Bold Italic
ZAPFDINGBATSZapf Dingbats

watermark

watermarkText

rotation

1.0.0Rotacja znaku wodnego.ZmiennoprzecinkowyWartość z przedziału 0.0 - 360.0.

permissions

groups

1.0.0Uprawnienia określające dla jakich zalogowanych użytkowników w systemie przy próbie otwarcia dokumentu zostanie uruchomiony hook. Wskazuje na grupy użytkowników systemowych.Tablica wartości tekstowychParametr opcjonalny, gdy nie jest uzupełniony to znak wodny widzą wszyscy.
Panel
titlePrzykładowa konfiguracja

Image Modified 

Code Blockinfo
languagetitlejsPrzykładowa konfiguracja JSON
linenumberstrue
[

{

  {
   "documentClass": "Dokumenty prawne",


   "watermark":
{
 {
        "type": "TEXT",


        "text": "Numer sprawy: {Numer sprawy}, Data rejestracji: {Data rejestracji}",


        "positionX%": 5,


        "positionY%": 5,


        "opacity": 0.7,


        "alignment": "BOTTOM_LEFT",


        "watermarkText":{


            "size": 15,


            "color": "LIGHT_GRAY",


            "fontType": "HELVETICA",


            "rotation":
0
}
},
 0
        }
    },
   "permissions":
{
 {
       "groups": ["Users", "Administrators"]

}
},
{
  
    }
  },
  {
   "documentClass": "Dokumenty prawne",


   "watermark":
{
 {
        "type": "BARCODE",


        "text": "{Numer sprawy}",


        "positionX%": 80,


        "positionY%": 10,


        "opacity": 0.5,


        "alignment": "BOTTOM_LEFT",


        "watermarkBarcode":{


            "format": "CODE_128",

       
            "codeWidth": 50,


            "codeHeight":
15
}
},
 15
        }
    },
   "permissions":
{
 {
       "groups": ["Users", "Administrators"]

}
}
  
    }
  }
]
Panel
titlePrzykład działania

Przykład działania dla powyższej konfiguracji JSON'a.

Oryginalny dokument:

Image Added

 Po otwarciu:

Image Added

Panel
titleChange log

1.0.170

  • Dodanie hook'a