CIB pdf toolbox technischer Leitfaden (DE)
15. Briefpapierfunktion, Overlay von Texten, Grafiken und Barcodes
15.1. Briefpapierfunktion
Allgemein
Zusätzlich geltende Anweisungen
Beispiele
Anmerkungen zu Seiten in verschiedenen Formaten
Beispiele mit verschiedenen Formaten
Allgemein
Durch Angabe der Eigenschaft „BackgroundFilename“ beim PdfJoin wird das Ergebnisdokument des Joins mit den in dieser Property spezifizierten PDF-Dateien hinterlegt. Hierbei sind verschiedene Angaben möglich, um das Hintergrunddokument auf die Seiten des Hauptdokuments beliebig zu verteilen.
Über die Property „BackgroundFilenameAsForeground” kann veranlasst werden, dass das Ergebnis-Dokument nicht hinterlegt wird, sondern die hier spezifizierte Datei in den Vordergrund gesetzt wird.
BackgroundFilenameAsForeground:
Mögliche Werte:
0 Dokument liegt im Hintergrund
(default)
1 Dokument liegt im Vordergrund
Die Property „BackgroundFilename“ wird wie folgt belegt:
BackgroundFilename=“{Seitenzahl(en)};FileName;{Seitenzahl(en)};FileName;...“
|
Bezeichnung |
Wert |
Wirkung |
|
BackgroundFilename |
||
|
Seitenzahl(en) |
keine Angabe oder “All” |
Auf allen Seiten verteilen |
|
“Odd” |
Auf ungeraden Seiten verteilen |
|
|
“Even” |
Auf geraden Seiten verteilen |
|
|
“First” |
Nur auf der ersten Seite |
|
|
“Last” |
Nur auf der letzten Seite |
|
|
“NoFirst” |
Alle Seiten bis auf die erste |
|
|
“NoLast” |
Alle Seiten bis auf der letzte |
|
|
Zahl |
Nur auf Seite Zahl |
|
|
Zahl1-Zahl2 |
Von Seite Zahl1 bis Zahl2 |
|
|
Zahl1-Zahl2,Zahl3, ...,ZahlN-ZahlM |
Auf mehreren Seiten oder Seitenbereichen verteilen (Komma als Trennzeichen) |
|
|
FileName |
Pfad zur Datei |
Die Seiten dieser Datei werden hinterlegt |
|
BackgroundAdjustment (ab Version 1.16.1)
|
AllExactMatches FirstExactMatch BestMatch |
|
Die Seitenangaben besitzen unterschiedliche Prioritäten, so dass niedrigere Prioritäten von höheren überschrieben werden können. Die Prioritäten sind wie folgt verteilt:
Priorität keine: All, Odd, Even, NoLast, NoFirst
Priorität DIRECT: Last, First, Zahl
Priorität RANGE: Zahl1 – Zahl2
Dabei gilt folgende Rangfolge: Keine Priorität < RANGE < DIRECT
Besitzen zwei Angaben gleiche Priorität, so gelten beide, ansonsten gilt die mit der höheren Priorität und niedriger priorisierte Angabe wird nicht angewendet.
Soll eine Seite eines Hintergrunddokuments durch mehrere Seitenangaben auf verschiedenen Seiten verteilt werden, sind diese durch Kommata zu trennen. Beispielsweise bedeutet First,Last, dass die Seite hinter die erste und letzte Seite des Eingabedokuments gelegt werden soll.
Ein Hintergrunddokument kann aus mehreren Seiten bestehen. In diesem Fall, können pro Datei mehrere Seitenangaben, durch Semikolon getrennt, gemacht werden (z.B. {First,Last;Even} So wird die erste Seite des Briefpapiers auf der ersten und letzten Seite des Hauptdokuments hinterlegt und die zweite Seite auf allen restlichen geraden Seiten). Die erste Angabe bezieht sich somit auf die erste Seite des Hintergrunddokuments, die zweite Angabe auf die zweite Seite usw. Zu beachten ist, dass die Seitenangaben in geschweifte Klammern zu setzen sind, sobald sie sich auf mehrere Seiten beziehen. Dies ermöglicht eine große Flexibilität in der Angabe auf welchen Seiten des Hauptdokuments, welche Seite der Hintergrunddokumente hinterlegt werden soll. In der Property „BackgroundFilename“ lassen sich auch mehrere Briefpapier-Anweisungen hintereinander angeben.
Zusätzlich geltende Anweisungen
Um auszudrücken, dass bestimmte Anweisungen zusätzlich gelten sollen, sind die Angaben durch geschweifte Klammern zu trennen.
Alles, was innerhalb der geschweiften Klammern steht ist durch oben genannte Prioritäten geregelt, zwischen den geschweiften Klammern gilt jedoch keine Priorisierung.
Soll eine Seite des Briefpapiers nicht verwendet werden, ist einfach eine 0 anzugeben.
{1;0;2} bedeutet also, dass die erste Seite hinter die erste Seite das Hauptdokuments gelegt wird, die 2. Seite hinter keine und die 3. Seite hinter die 2. Seite.
Folgende Beispiele sollen die Anwendung der Briefpapier-Funktionalität veranschaulichen:
Beispiele
Die Beispiele zeigen mögliche Aufrufe über die CIB runshell.
Die Kommandozeile der Beispiele liest sich wie folgt:
1. Property Backgroundfilename setzen
2. Runshellkommando PDF-Join = cibrsh.exe –fj
3. input output
A.
cibrsh.exe BackgroundFilename=“{First;All};backgrounds.pdf“
–fj inhalt.pdf output.pdf
Hier wird die erste Seite von backgrounds.pdf hinter die erste Seite von
inhalt.pdf gelegt, und die zweite Seite von backgrounds.pdf hinter die
restlichen Seiten von inhalt.pdf. Das Ergebnis wird in output.pdf gespeichert.
B.
cibrsh.exe BackgroundFilename=“First;firstbackground.pdf;All;normalbackground.pdf“
–fj inhalt.pdf output.pdf
Hier wird die erste Seite von firstbackground.pdf hinter die erste Seite von
inhalt.pdf gelegt, und die erste Seite von normalbackground.pdf hinter die
restlichen Seiten. B. macht das gleiche wie A., nur dass die zwei Seiten des
Hintergunds nun auf zwei Dateien verteilt sind.
C.
cibrsh.exe BackgroundFilename=“{Odd;Even};background.pdf;1-2;mainbackground.pdf“
–fj inhalt.pdf output.pdf
Hier wird die erste Seite von mainbackground.pdf hinter die erste und zweite
Seite von inhalt.pdf (wegen höherer Priorität von „1-2“ gegenüber „Odd“ und
„Even“) gelegt, die erste Seite von background.pdf hinter alle restlichen
ungeraden Seiten von inhalt.pdf und die zweite Seite von background.pdf hinter
alle restlichen geraden Seiten von inhalt.pdf.
D.
cibrsh.exe BackgroundFilename=“{1;2;3;4;5;6;7;8};background_8Seiten.pdf“
–fj inhalt.pdf output.pdf
Hier wird die erste Seite von background_8Seiten.pdf hinter die erste von
inhalt.pdf, die zweite hinter die zweite, die dritte hinter die dritte usw.
gelegt.
E.
cibrsh.exe BackgroundFilename=“{First;All};backgrounds.pdf“
–fj inhalt1.pdf;inhalt2.pdf;inhalt3.pdf output.pdf
Hier wird zunächst ein regulärer Join der drei Eingabedokumente (inhalt1.pdf …
inhalt3.pdf) durchgeführt und anschließend das Briefpapier wie unter A.
beschrieben hinterlegt.
Anmerkungen zu Seiten in verschiedenen Formaten
Eine Seite kann nur dann mit einer anderen Seite hinterlegt werden, wenn die Höhen und Breiten bis auf eine Toleranz von 3 pt gleich sind. Das bedeutet, dass die zu hinterlegende Seite höchstens 3 pt (entspricht 0,35 mm) höher oder breiter sein darf als die andere.
Zwei Seiten können nur miteinander vermischt werden, wenn ihre Höhen und Breiten (bis auf eine Toleranz von 3 pt) gleich sind. Wenn kein Briefpapier passt, wird eine Warnung im Trace ausgegeben aber kein Programmabbruch erzeugt.
Ab Version 1.16.1 der CIB pdf toolbox kann die Auswahl
der Hintergrundseite über die Property BackgroundAdjustment gesteuert werden:
Auswahl der ersten genau passenden Hintergrundseite oder Auswahl der am besten
passenden Hintergrundseite.
Wir eine dieser beiden Möglichkeiten gesetzt und das Hinterlegen scheitert,
erfolgt ein Programmabbruch mit Ausgabe einer Fehlermeldung (366). (
Möchte man ein Dokument, das gemischt aus Querformat-Seiten und Hochformat-Seiten besteht, mit einem Hintergrund unterlegen, ist dies möglich, wenn im Hintergrunddokument für beide Formate entsprechende Seiten enthalten sind.
Die Seiten für die unterschiedlichen Formate dürfen jedoch nicht auf mehrere Dateien verteilt sein.
Beispiele mit verschiedenen Formaten
cibrsh.exe BackgroundFilename=“{All;All};backgrounds.pdf“ –fj WechselndeFormate.pdf output.pdf
Die erste Seite von backgrounds.pdf ist eine Seite im Querformat, die zweite Seite eine Seite im Hochformat. Die Eingabedatei besteht sowohl aus Querformat-Seiten, als auch aus Hochformat-Seiten.Hier werden nun alle Seiten im Querformat mit der ersten Seite von backgrounds.pdf hinterlegt und alle Hochformat-Seiten mit der zweiten Seite von backgrounds.pdf
Natürlich kann man auch hier verschiedene Seitenangaben machen, wie etwa BackgroundFilename=“{Odd;Even;Odd;Even};backgrounds.pdf“
Hier besteht die Datei backgrounds.pdf aus 4 Seiten, die ersten beiden im Querformat, von denen die erste auf allen ungeraden Querformat-Seiten hinterlegt wird und die zweite auf allen geraden Querformat-Seiten. Die dritte und vierte Seite haben Hochformat und sind entsprechend auf ungeraden, bzw. geraden Hochformat-Seiten zu verteilen.