Versions Compared

Old Version 15

changes.mady.by.user Kamil Rogowski

Saved on

compared with

New Version Current

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.17

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).

Panel
titleParametry konfiguracyjne
Nazwa parametruOd wersjiNazwa parametru w konfiguracji JSONOpisTyp parametruUwagi i ograniczenia
Identyfikator klasy dokumentów1.0.17documentClassIdKlasa dokumentów wskazuje dla których dokumentów mają być brane pod uwagę parametry wstawiania znaku wodnego.Całkowity

 

Typ1.0.17typeOkreśla jakiego typu jest znak wodny.
Tekstowy
WartośćZnaczenie
BARCODEKod kreskowy
Format1.0.17formatOkreśla standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek). Tekstowy
Kod
WartośćZnaczenie
CODE_39Kod

Jednowymiarowy 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

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.

ZnakWartośćZnakWartośćZnakWartośćZnakWartość
00B11M22X33
11C12N23Y34
22D13O24Z35
33E14P25-36
44F15Q26.37
55G16R27space38
66H17S28$39
77I18T29/40
88J19U30+41
99K20V31%42
A10L21W32  

Image Added

 

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.

ZnakWartośćZnakWartośćZnakWartośćZnakWartość
00C12O24-36
11D13P25.37
22E14Q26space38
33F15R27$39
44G16S28/40
55H17T29+41
66I18U30%42
77J19V31($)43
88K20W32(%)44
99L21X33(/)45
A10M22Y34(+)46
B11N23Z35  

Code 93Image Added

 

CODE_128

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

Code_128B-2009-06-02.svg.pngImage Added

Identyfikator indeksu1.0.17indexIdWskazuje na indeks, z którego jest pobierana wartość do zakodowania w znaku wodnym.CałkowityWartość indeksu musi być typu tekstowego.
Szerokość znaku wodnego1.0.17codeWidthDefiniuje szerokość znaku wodnego 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.
Wysokość znaku wodnego1.0.17codeHeightDefiniuje długość znaku wodnego w pikselach.Całkowity 
Umiejscowienie1.0.17positionPozycjonuje znak wodny w odpowiedniej części strony. Do wykorzystania jest 9 predefiniowanych pozycji.Tekstowy
WartośćZnaczenie
TOP_RIGHTGórny prawy róg
TOP_LEFTGórny lewy róg
BOTTOM_RIGHTDolny prawy róg
BOTTOM_LEFTDolny lewy róg
TOPU góry na środku
BOTTOMNa dole na środku
LEFTNa środku po lewej stronie
RIGHTNa środku po prawej stronie
CENTERNa środku
Margines1.0.17marginDefiniuje 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.17opacityOkreśla przezroczystość wstawianego znaku wodnego na stronach dokumentu.ZmiennoprzecinkowyWartość z przedziału 0-1.
Uprawnienia1.0.17

permissions

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

 

Info
titlePrzykładowa konfiguracja JSON
[
  {
   "documentClassId": 2,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 30,
        "codeHeight": 30,
        "position": "RIGHT",
        "margin": 5.0,
        "opacity": 0.5
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }      
  },
  {
   "documentClassId": 1,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 60,
        "codeHeight": 60,
        "position": "LEFT",
        "margin": 5.0,
        "opacity": 0.5
    }
  }
]
Panel
titleChange log

1.0.17

  • Dodanie hook'a

1.0.26 (obowiązująca dokumentacja)

  • Naprawa sytuacji braku kontekstu użytkownika

1.0.X

  • Dodanie adnotacji @Deprecated
English

← Return to the list of hooks

Info

If you have a problem understanding how the hook works, check: Hook's mechanism

Panel
titleBasic information

Available from version: 1.0.17

Panel
titleDescription

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).

Panel
titleConfiguration parameters

Parameter name

From version

Parameter name in JSON configuration

Description

Paremeter type

Comments and restrictions

Document Class ID

1.0.17

documentClassIdThe document class indicates for which documents the watermark insertion parameters are to be considered.

Integer

 
Type 
1.0.17typeSpecifies what type of watermark is.Text
ValueMeaning
BARCODEBarcode
Format
1.0.17formatSpecifies standard for one-dimensional barcodes (writing information on one line, in the form of dashes). Text
ValueMeaning
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), $, /, +,%, *).

CharValueCharValueCharValueCharValue
00B11M22X33
11C12N23Y34
22D13O24Z35
33E14P25-36
44F15Q26.37
55G16R27space38
66H17S28$39
77I18T29/40
88J19U30+41
99K20V31%42
A10L21W32  

Image Added

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.

 CharValueCharValueCharValueCharValue
00C12O24-36
11D13P25.37
22E14Q26space38
33F15R27$39
44G16S28/40
55H17T29+41
66I18U30%42
77J19V31($)43
88K20W32(%)44
99L21X33(/)45
A10M22Y34(+)46
B11N23Z35  

Code 93Image Added

CODE_128

Variable length, high density alphanumeric code. It can encode characters from the entire ASCII range.

Code_128B-2009-06-02.svg.pngImage Added

Index ID
1.0.17indexIdIndicates the index from which the value to be encoded in the watermark is taken.IntegerThe index value must be of the text type.
Watermark width1.0.17codeWidthDefines the width of the watermark in pixels.TextThe 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.17codeHeightDefines the height of the watermark in pixels.Text 
Position1.0.17positionPositions the watermark on the appropriate part of the page. There are 9 predefined positions to use.Text
ValueMeaning
TOP_RIGHTUpper right corner
TOP_LEFTUpper left corner
BOTTOM_RIGHTLower right corner
BOTTOM_LEFTLower left corner
TOPTop middle
BOTTOMBottom middle
LEFTLeft middle
RIGHTRight middle
CENTERMiddle
Margin1.0.17marginDefines 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 
transparency1.0.17opacitySpecifies the transparency of the inserted watermark on the pages of the document.FloatValue in the range 0-1.
Permissions1.0.17permissionsPermissions defining for which users logged in to the system the hook will be run when trying to open a document.ObjectOptional parameter, when is not filled, everyone can see the watermark.
groupsIndicates groups of system users.Text table 
Panel
titleConfiguration example

 

Info
titleExample JSON configuration
[
  {
   "documentClassId": 2,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 30,
        "codeHeight": 30,
        "position": "RIGHT",
        "margin": 5.0,
        "opacity": 0.5
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }      
  },
  {
   "documentClassId": 1,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 60,
        "codeHeight": 60,
        "position": "LEFT",
        "margin": 5.0,
        "opacity": 0.5
    }
  }
]
Panel
titleChange log

1.0.17

  • Hook adding

1.0.26 (applicable documentation)

  •  Fix the situation where there is no user context

1.0.X

  •  Adding a @Deprecated Annotation