CIB format technischer Leitfaden (DE)

7. Prüfschablonen über CIB format/output benutzen

Allgemein
Festlegen der Prüfschablone über eine CIB format/output Eigenschaft
     ▸  Spezielle Properties zum Setzen der CheckMask (Prüfschablone)


Allgemein

(Implementiert ab CIB format Version 5.3.220)

Sie können dem CIB format/output per Property („CheckMask“) eine Prüfschablone setzen. Dort definieren Sie spezielle Bereiche (Rechtecke) die beim Bedrucken entweder

  • überhaupt nicht beschrieben werden dürfen (=forbidden) , dargestellt in Farbe orange
  • oder von Textpassagen beschrieben werden dürfen (=allowed), dargestellt in Farbe grün
  • oder Text enthalten müssen, z.B. Adressfelder in vorgesehenen Klarsichtfenstern, dargestellt in Farbe blau.

Verletzungen der definierten Prüfschablonen werden in rot markiert.

Eine mögliche Druckschablone hat in etwa den nachfolgend dargestellten Aufbau.



Festlegen der Prüfschablone über eine CIB format/output Eigenschaft

Benutzen Sie den CibPrSetProperty Befehl der CIB format/output Komponente als Aufruffunktion um über die Property „CheckMask“ eine Prüfschablone zu hinterlegen.

Bei der Konvertierung oder Ausdruck eines Dokumentes werden diese Eigenschaften berücksichtigt und auf den gewünschten Seiten an den angegebenen. Positionen, die vorgegebenen Prüfschablonen überprüft. Dabei werden Verletzungen von „verbotenen“ Bereichen angezeigt.
Die Anwendung der Prüfschablone ist auf die Ausgabeformate CIB format\pdf, CIB format\print und CIB format\meta (für CIB jView, CIB doXiview und CIB view) beschränkt (ab CIB format Version 5.8.2a).

Es ist möglich in dieser Property die Prüfschablonen für den „allowed“-, „mandatory“- und „forbidden“-Bereich oder für  mehrere Prüfschablonen nacheinander abzulegen. Pro Druckseite sind auch mehr als eine Prüfschablone erlaubt.

Über den CibPrGetProperty Befehl der CIB format/output Komponente können über die Property „CheckMaskViolations“ die Verletzungen der definierten Prüfschablonen angezeigt werden.


Spezielle Properties zum Setzen der CheckMask (Prüfschablone):

Optionsname

Optionswert

Datentyp

DrawCheckMask

 

Gibt an, ob eine Checkmask erstellt werden soll:

0      Es wird keine Checkmask erstellt. (default)

1      Checkmask wird erstellt

Char*

DrawCheckMaskViolations

Gibt an, ob Verletzungen von verbotenen Bereichen angezeigt werden sollen.

0      Verletzungen werden nicht angezeigt. (default)

1      Verletzungen werden angezeigt.

Char*

StopOnFirstCheckMaskViolation

Gibt an, ob bei erster Verletzung abgebrochen werden soll.

0      Es wird nicht abgebrochen (default)

1      Es wird abgebrochen.

Achtung:
Bei Prüfung eines Multi-RTFs wird bei Auftreten der ersten Verletzung die gesamte Verarbeitung abgebrochen, d.h. die restlichen Teil-RTFs werden nicht mehr verarbeitet.

Char*

CheckMask

Beschreibung der CheckMask-Property für Prüfschablonen.

Aufbau:
<Checkmasklist> ::= <Checkmask> | <Checkmask> ";" <Checkmasklist>

Es können mehrere Definitionen für Prüfschablonen aneinandergereiht werden. Sie werden durch Semikolon getrennt.

 

Beispiel:
CheckMask="{{1,3-40};{forbidden;2cm;2cm;5cm;4cm}};{{2,5,6};{allowed;2cm;2cm;5cm;4cm};{mandatory;1cm;1cm;6cm;7cm}};"

Char*

<Checkmask>

Beschreibung einer Schablone.

Aufbau:
<Checkmask> ::= "{" <Pages> ";" <mask areas> "}"

Für die Seiten, auf denen eine Prüfschablone stehen soll, werden die Schablonen-Bereiche beschrieben. Pro <Checkmask> können wahlweise „allowed“, „forbidden“- oder „mandatory“- Bereiche oder auch Kombinationen dieser Bereiche beschrieben werden.

 

<mask-area>

Beschreibung des Prüfschablonen-Bereichs (Rechteck).

Aufbau:
<mask-area> = {forbidden | allowed | mandatory;left;top;right;bottom[;ID]}

Forbidden        In diesem Rechteck darf kein Text stehen

Allowed            In diesem Rechteck darf Text stehen

Mandatory       In diesem Rechteck muss Text stehen

 

left;top Koordinaten des linken, oberen Eckpunktes des Rechteckes (siehe in Grafik der Punkt A)

right;bottom    Koordinaten des rechten, unteren Eckpunktes des Rechteckes (siehe in Grafik der Punkt B)

ID        Angabe eines Bezeichners(ID) der in den CheckMaskViolations mit ausgegeben wird

Bezugspunkt für die Koordinaten ist die linke, obere Ecke der Seite.

Durch Eingabe von negativen Werten kann der Bezugspunkt auf die rechte untere Ecke der Seite geändert werden (ab CIB format Version 5.3.223).

Unterstützt werden die Einheiten: mm, cm, in, ft;

Default: mm

 

<Pages>

Angabe der Seiten oder Seitenbereiche, auf denen die folgende Prüfschablone angebracht werden soll.
Die Seiten können bezogen auf das ganze Dokument oder auf eine Ausfertigung angegeben werden (ab CIB format Version 5.3.223).
Wenn die Prüfschablone auf alle Seiten einer Ausfertigung aufgebracht werden soll, muss die Bezeichnung der Textmarke um „All“ ergänzt werden.

 

Aufbau:
<Pages>= {[Ausf,][any page number | from-to| All | Even | Odd | NoLast | NoFirst | First | Last]}  *

Ausf=Bezeichnung der Textmarke für die Ausfertigung.

First (nur erste Seite),

NoFirst (nicht erste Seite),

Last (nur letzte Seite),

NoLast (nicht letzte Seite),

Even (ungerade Seiten)

Odd (gerade Seiten)

All (alle Seiten)

Wert (diese Seite)

Wert1-Wert2 (diesem Seitenbereich)

Wert1-Wert2[,]Wert3 (diesen Seiten/Seitenbereich)

 

CheckMaskViolations

Property liefert die Verletzungen der Prüfschablonen zurück.
(Get-Property).
Für jede Prüfschablone kann ein Bezeichner (ID) vergeben werden. Diese ID wird auch bei Ausgabe mitgegeben (ab CIB format Version 5.3.223).

Es wird ausgegeben:
Position des Textes, der die Verletzung verursacht (content).

Position der Checkmask, die verletzt wird (masks).

Beispiel:

{forbidden;50mm,50mm,150mm,100mm;myid1}.

Violations={{content;49.31;52.84;61.66;50.08;};{masks;{50;50;150;100;myid1}}}

Ausgabe im Trace:
Position des Textes, der die Verletzung verursacht (content).

Der Text, der die Verletzung verursacht und Art der Verletzung (text).

Position der Checkmask, die verletzt wird (masks).

Beispiel:
CheckMask: Content [ltrb={{content;49.31;52.84;61.66;50.08;};{masks;{50;50;150;100;}}}; text="Weiherweg"] is placed on the forbidden area [{50;50;150;100;}].

Ltrb = left, top, right, bottom

Char*

RefSearchMask

Property für CIB format/analyse, dient der Beschreibung von Such-Schablonen für REF-Felder.

Aufbau:
<Checkmasklist> ::= <Checkmask> | <Checkmask> ";" <Checkmasklist>

Es können mehrere Definitionen für Such-Schablonen aneinandergereiht werden. Sie werden durch Semikolon getrennt.

Weiterer Details zum Aufbau siehe Property „CheckMask“.

Hinweis:
In <mask-area> wertet RefSearchMask nur die Angabe „allowed“ aus.

Der CIB format/analyse liefert über callback die Namen aller REF-Felder eines RTF-Dokuments. Wenn SearchMasks gesetzt sind, wird in einem zweiten Durchlauf zu jedem REF-Feld geprüft, ob es innerhalb einer Such-Schablone liegt.

Ist dies der Fall gibt der callback zu dem Namen des REF-Feldes die Id 400 zurück.

Beispiel eines format/analyse-Aufrufs über Runshell:

cibrsh RefSearchMask="{{1};
{allowed;2cm;4cm;15cm;14cm}}" -xf test.rtf testout.csv

Char*