CIB format technischer Leitfaden (DE)

17. Allgemeine Properties

Die sogenannten "Properties" oder Eigenschaften bilden ein wesentliches Kriterium vor dem Aufruf der eigentlich auszuführenden Methode. Alle unten im Klartext genannten Optionsnamen sind in den einzelnen Headerdateien der Komponenten auch als define deklariert und auch über diese defines in Ihrem Sourcecode ansprechbar. Die verschiedenen Ausgabemodule besitzen weitere spezielle Properties, die dort in den einzelnen Unterkapiteln beschrieben sind.

Zum Setzen der Optionen steht die Funktion CibPrSetProperty und zum Abholen die Funktion CibPrGetProperty zur Verfügung.

Optionsname

Optionswert

Datentyp

"" (COMOD_PROP_SET_TO_DEFAULT)

NULL

Setzt alle Eigenschaften auf Ihre Defaultwerte zurück

void*

AbortDlg

(*)

0 (default) kein Abbruchdialog wird angezeigt

1 Seitenzähler mit Abbruchdialog wird angezeigt

-> Auswertung mit GetLastError-Property

Long (boolean)

AllowCutTableCells

(ab CIB format Version 5.3.231 und im Zweig
CIB format 5.3.226 ab 226m)

Wenn in eine Tabellenzelle mit fester Höhe ein Absatz (beliebigen Inhalts) eingefügt wird der höher als die Tabellenzelle ist, so muss er abgeschnitten werden.

Durch Ausschalten der Property „AllowCutTableCells“ wird dieses Abschneiden nicht mehr erlaubt, d.h. der CIB format bricht in diesem Fall mit Fehler 261 bzw. Fehler 277 ab. Der CIB format&analyze bricht nicht ab, sondern setzt den Callback 3001.

 

1   (default) Ein zu hoher Absatz wird abgeschnitten.

0   Ein zu hoher Absatz wird nicht abgeschnitten, sondern es erfolgt der oben beschriebene Fehlerausgang.

Hinweis:
Im Falle dass die Property „AnalysisFilename“ gesetzt ist, wird die Tabellenzelle, die die Verletzung verursacht, mit einem Rahmen von 1pt mit der Farbe rot in der XslFo-Ausgabe gekennzeichnet.

Char*

AnalyzeNonPrintableParagraph

(ab CIB format Version 5.3.231 und im Zweig
CIB format 5.3.226 ab 226l)

Gibt an, ob bei CIB format&analyze, CIB format syntaxcheckoder beim Auslesen von Fontproperties wie DocumentUsedFonts, etc. Schriftarten berücksichtigt werden, die nur zur Formatierung von Absatzzeichen, Zeilenwechsel, Zellende in Tabellen benutzt wurden.

1   (default) Alle Schriftarten werden berücksichtigt.

0   Die Formatierung der Absatzzeichen wird nicht berücksichtigt.

Char*

AnalysisFilename

(ab CIB format Version 5.3.221)

Ist diese Property gesetzt (z.B. AnalysisFilename=Analyseergebnis.txt) schaltet dies den Analysemodus aktiv. Alle Details der internen Analyse werden in der angegebenen Datei abgelegt.

Char*

AnalyseOptions

Über diese Property können Analyse-Optionen eingeschaltet werden.

Graphics  = Grafik-Daten werden analysiert und die entsprechenden Callbacks versorgt.

Char*

BarcodeFilename

kompletter String des Include-Barcode

Char*

BackgroundCallback

 

Wasserzeichen-/Formularhintergrund-Callback
Der Callback wird für jede Seite aufgerufen und erwartet einen GrafikString(identisch zur Property) aus der Callback-Funktion: z.B. (POS:(z-Order)|X-Pos,Breite;Y-Pos,Höhe;)Filename(;*) … .

Pointer

BackgroundFilename

Name einer Grafikdatei, die als Hintergrundgrafik auf die komplette Seite skaliert wird.

Char*

BlockSize

 

Steuert die interne Blockgröße zum Einlesen der Eingabedatei. Bei kleineren Werten wird weniger Speicher benötigt, ein zum verfügbaren Speicher passend hoher Wert beschleunigt jedoch die Verarbeitung, zum Beispiel von großen Multi-RTF-Dokumenten. Defaultwert ist 3MB.

Long

CallbackPointer

Der übergebene Pointer, kommt beim ViewCallback als a_pUser wieder zurück.

Pointer

CallerApplicationname

Beschreibender Name der aufrufenden Anwendung ggf. mit Versionsnummer.

Char*

CheckError

(ab CIB format Version 5.3.226)

Liefert den Fehlercode der letzten fehlgeschlagenen Prüfung. Tritt kein Fehler auf, wird 0 geliefert.

(Get-Property)

Char*

CheckHtmlAndPrintBraces

(ab CIB format Version 5.8.3d)

Über diese Property kann die Prüfung von Masken- und Druckbereichen gesteuert werden.
Bei Fehlern in der Strukturierung von Masken- und Druckbereichen wird normaler Weise Returncode 148 gemeldet.

Mögliche Werte:

0        Keine Prüfung auf korrekte Strukturierung der Masken- und Druckbereiche (default).

1        Prüfung wird durchgeführt.

Char*

ConfigFilename

Zeichenkette, die den Dateinamen und –pfad enthält. Wenn der Pfad oder die Datei nicht existieren, wird kein Fehler gemeldet, aber ein Eintrag im Trace erzeugt und es wird die Standardkonfiguration benutzt.

Char*

CountEvenOddEmptyPagesForSectionPages

Char*

(ab CIB format Version 5.3.243)

Schalter, um die Behandlung des Zählers SECTIONPAGES an das Verhalten von MS Word anzupassen.

Die Abschnitswechsel gerade/ungerade können ggf. zum Einfügen einer leeren Seite im Dokument führen. Diese leere Seite wird bei den Seitenzählern PAGE und NUMPAGES vom CIB format und MS Word mitgezählt. Beim Seitenzähler SECTIONPAGES haben MS Word und CIB format ein unterschiedliches Verhalten:
MS Word zählt die Leerseite nicht mit, der CIB format schon. Durch Ausschalten dieser Property kann das Verhalten des CIB format an MS Word angepasst werden.

Mögliche Werte:

0         Leerseite wird bei SECTIONPAGES mitgezählt (bisheriges Verhalten, default)

0      Leerseite wird bei SECTIONPAGES nicht mitgezählt, Verhalten wie MS Word

 

DefaultFont

Dokumentunabhängiger Defaultfontname  für Nurtext-Eingabedateien

Char*

DefaultFontSize

Dokumentunabhängige Pointsize für Nurtext-Eingabedateien.

Char*

DocumentId

Der hier übergebene individuelle Text wird bei der Feldanweisung { PRINTDATE \@ „IZ“ } eingesetzt.

Ist die Property nicht gesetzt, wird der CIB eigene Datumschalter \@ "IZ" als Zeitstempel verwendet.
Er gibt die Anzahl der Sekunden seit 0:00:00 aus.

Char*

DocumentUsedFonts

Nur CibPrGetProperty: Dokumentinformation über verwendete Schriftarten {Name;Größe;Attribute}.

Bei gesetzter IncludeText-Property werden auch die in inkludierten Dokumenten verwendeten Fonts ausgegeben. Jeder Font wird nur einmal ausgegeben.

Beispiel:

{Frutiger VR;6-48;normal,bold,italic,bold italic;};{Courier New;6-48;normal,bold,italic,bold italic;}

Char*

DocumentUsedOriginFonts

Nur CibPrGetProperty: Dokumentinformation über original Schriftarten im InputDokument {Name;Größe;Attribute}.

Bei gesetzter IncludeText-Property werden auch die in inkludierten Dokumenten verwendeten Fonts ausgegeben. Jeder Font wird nur einmal ausgegeben.

Beispiel:

{Frutiger VR;6-48;normal,bold,italic,bold italic;};{Arial;10,12;normal,bold italic;}

Char*

DocumentUsedBookmarks

(ab CIB format Version 5.3.237)

Get

Ausgabe der in einem Dokument verwendeten Textmarken.
Zu jeder Textmarke werden die Seiten angegeben, die sie beinhaltet. Dabei kann es sich um Einzelseiten und/oder einen oder mehrere Seitenbereiche handeln.

Syntax:
<DocumentUsedBookmarks> ::= <Textmarke> | <Textmarke> ";" <DocumentUsedBookmarks>

<Textmarke> ::= "{" <Text> ";" <Seitenliste> "}"

<Seitenliste> ::= <Seiten> | <Seiten> "," <Seitenliste>

<Seiten> ::= <Zahl> | <Zahl> "-" <Zahl>

Beispiel:
DocumentUsedBookmarks={AUSF1;1-5};{AUSF3;4,6-7}

Char*

DocumentReplacedFonts

(ab CIB format Version 5.3.236)

Nur CibPrGetProperty: Ausgabe einer Liste von Font-Ersetzungen.
Falls ein Font auf dem System nicht vorhanden ist, wird er vom CIB format durch einen möglichst „ähnlichen“ installierten Font ersetzt. Die durchgeführten Font-Ersetzungen werden in dieser Property dokumentiert in der Form:

<Font-Ersetzungen> ::= <Font-Ersetzung> | <Font-Ersetzung> ";"<Font-Ersetzung>

<Font-Ersetzung> ::= "{" <Alter Font> ";" <Neuer Font> "}"

<Alter Font> ::= <Fontname>

<Neuer Font> ::= <Fontname>

<Fontname> ::= <Text>

Jede Font-Ersetzung wird nur einmal ausgegeben.

Beispiel:
DocumentReplacedFonts = {Frutiger VR;Times};{HelveticaNeueLT Com 65 Md;Times};{Arial;Times}

Char*

DocumentUsedPaperFormats

(ab CIB format Version 5.3.222)

Nur CibPrGetProperty:

Liefert eine Liste der im Dokument verwendeten Seitengrößen und Ausrichtungen.
Jede Kombination wird nur einmal ausgegeben.

Syntax:
{Höhe in mm,Breite in mm;Orientierung}

Beispiel:
{297mm,209mm;portrait,landscape};{419mm,297mm;portrait}

Char*

DocumentUsedGrafics

(ab CIB format Version 5.3.222)

Nur CibPrGetProperty:

Liefert eine Liste der in der erzeugten Ausgabe vorhandenen Grafiken und deren Format.

<Grafik> ::= < Grafik > | < Grafik > ; < Grafik >
< Grafik > ::= { <Grafiktyp> ; <BitsproPixel> }
<GrafikTyp> ::= RGB | B/W | JPEG | JPEG RGB | GRAY
<BitsproPixel> ::= Integer

 

Beispiel:
 {RGB;24};{RGB;2}

Achtung:

 Diese Property ist bisher nur für FormatPdf implementiert.

Char*

DuplexPrint

Windows:

FALSE: Duplexdruck wird deaktiviert.
TRUE: Duplexdruck wird aktiviert

Long (boolean)

DuplexPrint2

DuplexPrint2 erweitert die Ausprägung für den Duplexdruck und wird anstatt der Property DuplexPrint verwendet.

"DuplexDefault":
Es wird unter Windows der im Druckertreiber gesetzte Standardwert verwendet. Unter Linux/Unix wird der Wert aus der per Property gesetzten PPD-Datei verwendet. Ist keine PPD-Datei vorhanden, wird DuplexPrintLong verwendet.

"DuplexPrintShort":
Es wird beidseitig bedruckt, wobei das Blatt wie bei einem Kalender an der kurzen Seite gedreht wird.

"DuplexPrintLong":
Es wird beidseitig bedruckt wobei das Blatt wie bei einem Buch an der langen Seite gedreht wird.

"SimplexPrint":
Es wird einseitig bedruckt.

Char*

 EmfResolution

(ab CIB format Version 5.3.230)

Diese Property wird an den CIB jView gesetzt, um eine bessere Ausgabe-Qualität von EMF/WMF Grafiken zu erreichen.

Angabe in dpi.

Default: 300 dpi

(Für HTMLwird  weiterhin 96 dpi verwendet)

Char*

EncryptPassword

Passwort

Char*

EvenOdd

EvenOdd gibt an, ob gerade und/oder ungerade Seiten gedruckt bzw. konvertiert werden sollen.

"EvenOnly":
Nur gerade Seiten drucken

"OddOnly":
Nur ungerade Seiten drucken

"EvenAndOdd":
Gerade und ungerade Seiten drucken (Default)

Char*

FaxAvailable

 

 

FaxOnly

 

 

FieldAnalyzeCallback

Liefert Callback IDs für dokumentierte RTF Felder.

Zu der genauen Schnittstellen-Beschreibung siehe Kapitel „Analyse Callback“.

Pointer

FileFontFilter

FileFontFilter setzt das zu unterstützenden Font Format.

"TTF":
Nur TrueType Schriftarten(*.ttf) für die Konvertierung verwenden.

"Type1":
Nur Type1 Schriften(*.pfa, *.pfb) für die Konvertierung verwenden.

"":
Alle unterstützten Schriftarten verwenden.(Default)

Char*

FirstPageNumber

Veraltet
Abgelöst durch Property PageSelection

Startseitennummer für den Ausdruck (wenn z.B. mehrere Kapitel in separaten Jobs gedruckt werden)

Long

FontWorkSpace

Bezeichnet das Verzeichnis in dem die Fonts installiert sind, die für die dirkte PostScript Erzeugung bzw. für den direkten PostScriptdruck benutzt werden können.

Char*

FontMapping

(ab CIB format Version 7.0.12)

Über den Inhalt dieser Property kann eine komplette Ersetzung von im Dokument verwendeten Schriftarten bzw. ein Austausch von einzelnen Schriftgrößen vorgegeben werden.

Syntax:

FontMapping=
{<Originalfontname>:<neuer Fontname>;<alte Schriftgröße in Halbpunkt>:<neue Schriftgröße in Halbpunkt>,... }

-     Geschweifte Klammern trennen komplette Schriftenanweisungen je Font

-     Doppelpunkte trennen Original und neu

-     Semikolon trennt Fontnamenpaare von Schriftgrößenpaaren

-     Kommata trennen Schriftgrößenpaare untereinander

 

Beispiel:
FontMapping={Arial:Frutiger VR;20:24,16:20}

 

Zu beachten:

-      Die Property gilt immer für das gesamte Dokument

-      Es können in gleichbleibender Schriftart auch nur Schriftgrößen verändert werden

-      Es können nur die Fontnamen ersetzt werden und alle Schriftgrößen bleiben gleich

-      Zeichenattribute wie fett, kursiv, unterstreichen können nicht einzeln ersetzt werden, sondern nur über den gesamten Font beeinflusst werden

-      Syntaxfehler in der Anweisung führen zu keinem Abbruch sondern nur zur Nichtberücksichtigung der Anweisung

-      Ein Dokument kann durch Verwendung dieser Property sein Erscheinungsbild komplett verändern

-     Diese Property ist in folgender Konstellation im RTF per { PRINT „CIB:FontMapping=   } Anweisung aktivierbar:
Die Anweisung muss das erste Kommando im Text sein, also bevorzugt in der Kopfzeile bzw. Kopfzeile Folgeseite (bei „Erste Seite anders“) stehen.
Ansonsten wird sie überlesen und nicht ausgewertet.

Char*

GeneratedDocumentCount

 

Liefert die Anzahl der erzeugten Ausgabedokumente.

Im Normalfall wird „1“ zurückgeliefert, außer bei MultiRtfSingleOutput=0, wenn für jedes RTF ein eigenes Ausgabedokument erstellt wird.

Im Fehlerfall, d.h. Abbruch und gar keine Ausgabe, wird „0“ zurückgegeben.

Long

IncludeText

 

TRUE (default):
Der Text der in dem Feld INCLUDETEXT angegebenen Datei wird in das Dokument eingefügt.

FALSE:
Es wird ein Hyperlink auf die Datei eingefügt

Long (boolean)

InitialOutputLength

Gibt die Größe Bereichs zu Beginn des Ausgabe-Puffers an, der für die interne Verarbeitung reserviert ist.

Defaultwert: 1MB

Long

InputCodepage

CodeTabelle der Eingabedatei.

"Ascii":

American Standard Code for Information Interchange

"Pca":
IBM PC code page 850, used by IBM Personal System/2 (default OS/2)

"Ansi":
American National Standards Institute (default Windows)

Char*

InputFilename

Name der Eingabedatei

Char*

InputFormat

Legt das Format der Eingabedatei (InputFilename) fest.

FormatRTF: Eingabedatei hat RTF-Format(Default)

FormatText: Eingabedatei hat Text-Format

Als Eingabeformate sind auch die Grafikformate Tiff, Png, Bmp und Jpg möglich.

Emails können in den Formaten msg und unicode msg verarbeitet werden.

Char*

InputMemoryAddress

Übergabe der Auftragsdatei im Hauptspeicher. Diese Property enthält eine Folge aus Speicheradressen von lesbaren Speicherblocks und deren Länge. Die Speicheradressen und die Längen werden dezimal angegeben. Es wird abwechselnd eine Adresse und eine Länge angegeben, die Zahlenwerte sind durch Strichpunkte getrennt. Diese Speicherblocks müssen – wenn zusammengesetzt – die Auftragsdatei enthalten.

Char*

LibraryFilenameChart

Name der Chart-Library-Datei

Char*

LicenseCompany

Name des Lizenznehmers für den in Verbindung  mit der Property LicenseKey lizenzpflichtige Funktion(en) des CIB format/output freigeschalten werden.

Char*

LicenseInfo

Liefert die gesetzten Lizenzen im Klartext durch Strichpunkt getrennt, etwa 'print;pdf' mögliche Werte siehe COMOD_OPT_LICENSE_INFO_.

Char*

LicenseKey

Lizenzschlüssel, welcher in Verbindung mit dem richtigen Lizenznehmer lizenzpflichtige Funktion(en) freischaltet.

Char*

LogoFilename

Name einer Grafikdatei, die als Vordergrundgrafik auf die komplette Seite skaliert wird.

Char*

MarkEmptyRecAreaAsOneLine

(ab CIB format Version 5.8.0)

Nur für Metafile-Generierung

Über diese Property kann ein Verhalten aus alten Versionen des CIB format reaktiviert werden:
Bei einem leeren REC-Bereich wird im Viewer eine ganze Eingabe-Zeile vorgeblendet.

0      Vorblenden eines kurzen Eingabebereichs (ca. 1 Zeichen) (default)

1      Vorblenden einer ganzen Eingabezeile

Char*

MarkSingleLineRecAreaAsOneLine

(ab CIB format Version 5.8.2b)

Nur für Metafile-Generierung

Über diese Property kann ein Verhalten aus alten Versionen des CIB format reaktiviert werden:
Bei einem belegten (einzeiligen) REC-Bereich wird im Viewer immer eine ganze Eingabe-Zeile vorgeblendet (unabhängig von der Länge des Inhalts).

Der Defaultwert ist FALSE

0      Vorblenden eines Eingabebereichs in der Länge des aktuellen Inhalts. (default)

1          Vorblenden einer ganzen Eingabezeile

Char*

MemoryOutputCallback

Übergabe der Callbackadresse, um die erzeugte Auftragsergebnisdatei entgegenzunehmen. Nullterminierte Zeichenkette, die den dezimalen Wert der Adresse einer ausführbaren Funktion enthält.

Schnittstellenbeschreibung siehe Kapitel „MemoryOutputCallback”

Char*

MemoryOutputUserdata

Übergabe eines beliebigen Zeigers, der bei jedem Aufruf des 'MemoryOutputCallback' der Callbackfunktion zur Verfügung gestellt wird.Nullterminierte Zeichenkette, die den dezimalen Wert der Adresse enthält. Die Property muss nicht gesetzt werden, muss dann aber vor dem Aufruf der Execute-Funktion gesetzt sein.

Char*

MetaFilename

Name des Metafiles, welches mit den CIB viewern angezeigt wird.

Char*

ModuleName

Beschreibender Name des aktiven Erstellungsmodules ggf. mit Versionsnummer

Char*

MultiRtfError

(ab CIB format Version 5.3.226)

Liefert einen String zurück, der den Index des fehlerhaften Teil-Rtfs mit dem zugehörigen Fehlercode enthält.

(Get-Property)

 

Die Property funktioniert nur bei
MultiRtfSingleOutput = 1
und unterstützt die Fehlercodes
255 = CheckMask Error
256 = FontMask Error

 

Beispiel:

1,255;2,256;3,255

Char*

MultiRtfIndex

Onebased Index des gerade mit Load() eingelesenen Teil-Rtf’s eines MultiRTF-Dokumentes.
(Leseproperty)

Integer

MultiRtfNumPaging

Behandlung der MultiRtf Seitenzahlen angeben.

FALSE:
Bei jedem Rtf-Dokument werden die Seitenzahlen bei 1 erneut begonnen.

TRUE:
Die Seitenzahlen werden über das komplette MultiRTF-Dokument durchgezählt.

Long (boolean)

MultiRtfPending

Mit dieser Property wird mitgeteilt ob ein weiteres Teil-Rtf einem MultiRtf-Dokument für Load() vorhanden ist. Diese Property steht VOR dem Öffnen eines MultiRtf-Dokumentes auf FALSE. Erst nach dem Einlesen eines Teil-Rtfs, sofern es ein weiteres Teil-Rtf in der Eingabedatei gibt, wird sie auf TRUE gesetzt.

FALSE:
Es ist kein weiteres Teil-Rtf vorhanden.

TRUE:
Ein weiteres Teil-Rtf vorhanden.
(Leseproperty)

Long (boolean)

MultiRtfSingleOutput

FALSE:
Generiere für jedes Teil-Rtf eine eigene Ausgabedatei, welche um eine Nummerierung erweitert wird.(default)

TRUE:
Hänge alle Teil-Rtfs zu einer einzigen Ausgabedatei zusammen.

Long (boolean)

NationalDigits

Ersetzung der Ziffern 0-9 durch die mit Strichpunkt getrennten angegebenen dezimalen UNICODE-Werte

Char*

OutputFilename

Name der Ausgabedatei

Char*

OutputFilenameDocProperty

(ab CIB format Version 5.3.243)

Diese Property wird mit dem Namen der DocProperty belegt, die den OutputFilename enthält. Damit wird dieser Wert als Name für die Ausgabedatei verwendet.

Zu beachten:
Der Wert der  Property OutputFilename hat Vorrang.

Für MultiRTFs gilt:
Bei MultiRtfSingleOutput=1 bekommt die Ausgabedatei den Namen aus der DocProperty des ersten RTFs.
Bei MultiRtfSingleOutput=0 kann jeder Ausgabedatei über die DocProperty der Name gezielt vorgegeben werden.

Char*

OutputFormat

Legt das Format für die Ausgabedatei (OutputFilename) fest.

FormatAscii (veraltet, stattdessen FormatText verwenden)

FormatText

FormatHtml

FormatPcl

FormatPrinterCups

FormatPrinterPcl

FormatPdf

FormatPdfA

FormatPdfUA

FormatPs

FormatPrinterPs

FormatTiff

FormatPng

FormatJpeg

FormatSyntaxCheck

FormatWebview

FormatXslFo

FormatPrinter(default)

Char*

ShowTHB

(ab CIB format Version 7.0.13f)

Diese Property wird nur zu generischen Zwecken innerhalb der CIB workbench ab Version 2.9.202 eingesetzt (Anwendungsfall: Texthandbuchgenerator).

Sie wird nur für OutputFormat=FormatRtf unterstützt.

Mögliche Werte:

0          ShowTHB nicht aktiv (default)

1          ShowTHB aktiviert

Achtung:

Für Details zur Verwendung dieser Property siehe Handbuch der CIB workbench.
Einsatz dieser Property nur nach Rücksprache mit den CIB Beratern.

Char*

PageSelection

 

Geben Sie hier die gewünschte Seitenselektion an.
zum Beispiel:

Die Angabe „1-3“ entspricht Seite 1 bis 3,
durch die Angabe „1;3“ erhält man Seite 1 und 3. (Semikolon als Trennzeichen !)

 

Angabe von Ausfertigungen:

<Textmarkenname>;<Textmarkenname2>
oder
<Textmarkenname>,<Anzahl zusätzl. Kopien>

Hinweis:

Semikolon trennt die Namen der Ausfertigungen. Mit Komma werden die Anzahl zusätzlicher Kopien angefügt

 

Achtung:

Die Textmarken müssen im Dokument auf Textseiten definiert werden. Textmarken in Kopf- oder Fußzeilen werden nicht ausgewertet.

Char*

PageCurrent

Veraltet
Abgelöst durch Property PageSelection

Nur aktuelle Seite mit dieser Nummer drucken.

Long

PageEnd

Veraltet
Abgelöst durch Property PageSelection

Drucke folgende Seiten (einschließlich Ende)

Long

PageStart

Veraltet
Abgelöst durch Property PageSelection

Drucke folgende Seiten (einschließlich Start)

Long

PageStatus

 

 

ParentHwnd

Optionales Windowhandle Ihrer Anwendung, zu dem verschiedene Masken (z. B. Druckdialog oder DruckerSetupdialog) in Beziehung stehen sollen, z. B. zentriert oder modal.

(default: HWND_DESKTOP)

Long

PrintCopies

Anzahl der zusätzlichen Kopien.
Default ist 0.

Beispiel: Wird der Wert auf 1 gesetzt, erhalten Sie ein Original und eine Kopie.

Long

PrintHeaderFooterAlways
(ab CIB format Version 5.3.238a)

 

Mit dieser Property können Kopf- und Fußzeilen auf der durch einen „Abschnittswechsel (ungerade Seite)“ erzeugten Leerseite explizit eingeblendet werden.

Mögliche Werte:
0          Leerseite, ohne Kopf-/Fußzeilen
            (default)

1          Leerseite mit Kopf-/Fußzeilen

Dies wurde realisiert, da sich in der Praxis eine Abweichung vom Standard als sinnvoll und oft benötigt erwiesen hat.

Konkreter fachlicher Anwendungsfall:
In einem Dokument sind mehrere Vorgänge aneinander gereiht. Der Anwender möchte, dass jeder neue Vorgang auf einer ungeraden Seite beginnt, damit bei einem Ausdruck und aktivem Duplex jeder neue Vorgang auf einem neuen Blatt beginnt. Dies wird durch Einfügen eines „Abschnittswechsel (ungerade Seite)“ erreicht.

Im Standard verhält es sich so, dass auf die eingefügte (leere) Seite keine Kopf- bzw. Fußzeile ausgegeben wird. Die Seite wird aber im Seitenzähler mitgezählt. Damit erhält man bei einer angedruckten Seitenzahlangabe (z.B. ‚Seite 3 von 12‘) eine Lücke im Dokument (eine ‚Seite 4 von 12‘ gäbe es nicht). Dies ist unschön, unvollständig und evtl. sogar rechtlich ungültig.

Mit Setzen von PrintHeaderFooterAlways=1 gibt man vor, dass auch auf den eingefügten Seiten die Kopf- und Fußzeile ausgegeben wird.
Das beabsichtigt unterschiedliche Verhalten zu MS Word ist zu berücksichtigen.

Char*

PrintRotated

(ab CIB format Version 5.6.249d)

Nur für InputFormat=FormatTiff

Seiten werden entsprechend der Grafik-Abmessungen (Höhe und Breite) gedreht.

Es gilt:
Bei Grafikseiten mit Höhe >= Breite erfolgt die Ausgabe im Hochformat, ansonsten im Querformat

Mögliche Werte:
0          kein Drehen  (default) 

1        Seite wird in Abhängigkeit von der Grafikgröße gedreht

Voraussetzung:
Die Properties PaperHeight und PaperWidth müssen gesetzt sein.

Char*

PrintScaling

(ab CIB format Version 5.6.249d)

Nur für InputFormat=FormatTiff

Angabe, welche Optionen angewendet werden sollen um die Grafikseiten passend zum bedruckbaren Bereich zu skalieren.

Mögliche Werte:

PrintScaleNone            Die Grafikseite wird nicht skaliert, d.h. die Abmessungen (Höhe und Breite) der Grafiken bleiben unverändert. (default)

PrintScaleDown           Zu große Grafikseiten werden auf den bedruckbaren Bereich herunter skaliert, zu kleine bleiben unverändert.

PrintScaleFit    Die Grafikseiten werden passend auf den bedruckbaren Bereich skaliert, d.h. größere verkleinert und kleinere vergrößert.

Voraussetzung:
Die Properties PaperHeight und PaperWidth müssen gesetzt sein.

Char*

PrinterAvailable

PrinterAvailable liefert alle verfügbaren Drucker
(GetProperty)

Char*

PrinterChanged

TRUE:
Drucker wurde geändert.

FALSE:
Der Drucker wurde nicht geändert.

Long (boolean)

PrinterLocalisation

Definition der Druckertypen die mit PrinterAvailable geholt werden sollen

"PrinterDefault":
Liefert den Standarddrucker.

"PrinterLocal":
Liefert die lokalen Drucker.

"PrinterNetwork":
"PrinterRemote":
"PrinterShared":
Liefert die über das Netzwerk angeschlossenen Drucker.

"PrinterCUPS":
Liefert die über das Common Unix Printing System angeschlossenen Drucker.

"PrinterDuplex":
Liefert die über das Common Unix Printing System angeschlossenen Drucker, welche laut CUPS Duplex unterstützen.
(Nur unter Unix\Linux verfügbar.)

"PrinterAcceptingJobs":
Liefert die über das Common Unix Printing System angeschlossenen Drucker, welche laut CUPS derzeit Druckjobs akzeptieren. D.h. alle Drucker in CUPS mit dem Flag "acceptingjobs = true" werden zurückgeliefert.
(Nur unter Unix\Linux verfügbar.)

Char*

PrintedPageCount

Liefert die Anzahl der vom CIB format ausgegebenen Seiten zurück.

Das bedeutet beim

CIB format/print: Anzahl gedruckte Seiten

CIB format/pdf: Anzahl Seiten des Pdf).

View/Edit: Anzahl der zurückgespeicherten Seiten des Dokuments

Long

PrintedPageCount2

(ab CIB format Version 5.3.231 bzw. 209e)

Enthält Anzahl der tatsächlich gedruckten Seiten unter Berücksichtigung der PageSelection etc.

Char*

PrinterName

Windows:
Unter Windows wird der gewünschte Druckername verlangt. Die Angabe kann mit Domain oder Serverbezeichnung erfolgen.

Char*

ProductLicense

Setzen des Produkts und Abfragen, ob es lizensiert ist.

Long

RecFieldContentFilenames

(ab CIB format Version 5.3.228)

 

 

 

 

 

 

(ab CIB format Version 5.3.237)

Im RTF enthaltene REC-Felder können über Property gefüllt werden. Hierzu wird dem CIB format der Name einer RTF-Datei, bzw. bei mehreren REC-Feldern eine Datei-Liste, übergeben. Der Inhalt der RTF-Datei(en) wird in die REC-Bereiche eingefüllt.

Beispiel:
RecFieldContentFilenames="rec1.rtf;rec2.rtf;rec3.rtf"

Achtung: Diese Property wird nicht mehr unterstützt.
Die Funktionalität zum Einmischen von REC-Snippets (bislang CIB format recombine) wurde in das Modul CIB merge ausgelagert (CIB merge recombine).

Char*

RemoveFile

FALSE:
Die gedruckte Datei bleibt nach dem Druck bestehen. (default)

TRUE:
Die gedruckte Datei wird nach dem Druck entfernt.

Long (boolean)

ReverseOrder

Legt die Seiten-Reihenfolge bei der Ausgabe fest.

FALSE (0)     (default):
Normale Reihenfolge bei der Ausgabe,
Seite 1 bis n.

TRUE:
Ausgabe in umgekehrter Reihenfolge,
Seite n bis 1.

Long (boolean)

ShowFields

FALSE:
Felder werden ausgewertet. (default)

TRUE:
Anzeige der Felder analog zu Word

Long (boolean)

ShowFieldInformation
(ab CIB format Version 5.3.221)
Diese Property ist ausschließlich für die Unterstützung des CIB view implementiert und freigegeben)

 

Setzen der auszugebenden Information für REF- und MergeField-Felder in OutputFormat.

None: keine Ausgabe

Fieldname(default): Name des Feldes wird ausgegeben

Field: Komplettes Feld mit geschweiften Klammern wird ausgegeben, z.B. { REF Variable }

Fieldresult: der im RTF hinterlegte Fieldresult wird ausgegeben

Char*

ShowHiddenText

FALSE:
Verborgen formatierter Text wird nicht ausgegeben. (default)

TRUE:
Verborgen formatierter Text wird ausgegeben

Long (boolean)

ShownonprintableCharacters

FALSE:
Nicht druckbare Zeichen werden ignoriert. (default)

TRUE:
Nicht druckbare Zeichen werden ausgegeben.

Long (boolean)

SortedPrint

Ausgabe von sortierten oder unsortierten Kopien auf den Drucker. Ein unsortierter Druck ist nur bei SimplexDruck möglich.

Mögliche Werte:
(Ausgabe-Beispiel mit zweiseitigem Dokument und einer Kopie)

FALSE: Unsortierte Ausgabe
Seitenreihenfolge: 1;1;2;2

TRUE: Sortierte Ausgabe(default).
Seitenreihenfolge: 1;2;1;2

Long (boolean)

StopOnFirstFontReplacement

(ab CIB format Version 5.6.251)

Bei gesetzter Property beendet der CIB format die Verarbeitung im Falle, dass eine Font-Ersetzung stattfindet. Es wird Returncode 278 ausgegeben.

Mögliche Werte:

0    (Default) Bisheriges Verhalten bleibt erhalten, d.h. kein Abbruch.

1    Abbruch im Falle einer Fontersetzung.

Char*

StopOnMissingGraphic

(ab CIB format Version 5.3.231e)

Bei gesetzter Property beendet CIB format die Konvertierung/den Druck bei einer fehlenden Grafik mit dem Returncode 56.

Mögliche Propertywerte:

"0"
Ein Platzhalter(Kreuz) wird für fehlende Grafiken ausgegeben (default)

"1"
Bei einer fehlenden Grafik wird mit Returncode 56 beendet.

Char*

TextTabSize

(ab CIB format Version 5.6.249)

Über diese Property kann für Textdateien die Tabulator-Schrittweite vorgegeben werden. Das Verhalten wird damit an das des Notepads angepasst.

„0“       Verhalten wie bisher, identisch zu MS Word (default)

„n“       Tabulator-Schrittweite ist n Zeichen

InputFormat=FormatText
OutputFormat=FormatWebview

In der Berechnung werden die Angaben aus “DefaultFont“ und „DefaultFontSize“ verwendet. Sind diese Properties nicht versorgt, werden Default-Werte herangezogen: "Times New Roman" und 12pt.

Achtung: Die Property macht nur Sinn für Monospace-Fonts.

Char*

TraceFilename

Name der Protokolldatei in die ein Trace geschrieben
werden soll. Diese Eigenschaft kann zur Laufzeit dazugeschalten werden, um im Fehlerfall durch einen anschließenden Wiederholungslauf diesen zu protokolieren.

Char*

UseHyphenation

(ab CIB format Version 6.0.6)

(ab CIB format Version 5.3.240)

Definiert, ob Silbentrennung eingeschaltet wird oder nicht.

None    Keine Silbentrennung (default).

Always  Silbentrennung wird im gesamten Dokument             verwendet.

Auto        Es werden die im RTF-Dokument durch WORD gesetzten Definitionen für die Silbentrennung verwendet. Im Detail wird geprüft, ob die Document Formatting Property „\hyphauto“ oder die Paragraph Formatting Property „\hyphpar“ gesetzt wurden. Ist eine dieser beiden Properties auf 0 gesetzt, findet keine Silbentrennung statt. Sind die Tokens im PDF nicht gesetzt, wird für beide per default der Wert 1 angenommen.

Hinweise:

-        DictionaryWorkSpace muss gesetzt werden.

-        Die hier eingesetzten Wörterbücher sind nicht identisch zu denen von MS WORD.

-        Worte, die Sonderzeichen enthalten (z.B. Punkt, Bindestrich) gehen nicht in die automatische Silbentrennung.

-        Worte, die einen bedingten Bindestrich (STRG-) enthalten, gehen nicht in die automatische Silbentrennung, sondern werden, falls nötig, an der markierten Stelle getrennt.

Char*

DictionaryWorkSpace

(ab CIB format Version 6.0.6)

(ab CIB format Version 5.3.240)

Verzeichnis, in dem sich die Wörterbücher für die Silbentrennung und Rechtsschreibprüfung befinden.

Ist nichts angegeben, wird in dem Verzeichnis gesucht, in dem sich die Dll befindet.

Char*

OverrideLanguage

(ab CIB format Version 6.0.6)

(ab CIB format Version 5.3.240)

Definiert die Sprache für das RTF Dokument, nach deren Regeln die Silbentrennung erfolgen soll. Ist keine angegeben, wird die im RTF-Dokument hinterlegte Sprache genommen.

Die Sprache wird in der Syntax  xx_YY  eingegeben.

xx         Sprachencode nach Norm ISO639-2
YY        Ländercode nach Norm ISO_3166

Bisher implementierte Sprachen:
de_DE, en_GB, en_US, es_ES, fr_FR

Char*

DefaultLanguage

Definiert die Standardsprache für das RTF Dokument, falls im RTF Dokument selbst keine Standardsprache festgelegt ist. Die Property hat die gleiche Syntax wie die Property „OverrideLanguage“.

Char*

UseComplexFieldResults

(ab CIB format Version 5.3.237g bzw.
5.3.239)

Durch Setzen dieser Property kann die Ausgabe des Fieldresults beeinflusst werden.

Mögliche Werte:

0    (Default) Bisheriges Verhalten bleibt erhalten.

1    Geändertes Verhalten bei Ausgabe des Fieldresults.

Folgende Änderungen werden ausgelöst:

·         Nur bei PDF:
REF-Felder (auch mit Schalter cib-formfield) berücksichtigen nun „komplexe“ Formatierungen (Absätze, Tabellen, usw.) im Fieldresult.
(Bisher wurde nur der Text aus dem Fieldresult von REF-Feldern ausgegeben, weitere Formatierungen aber ignoriert.

 

·         Alle Ausgabeformate :
IF-Felder zeigen ihr Fieldresult an.

Bei geschachtelten Feldern/Funktionen wird nur das Äußerste ausgegeben.

Char*

UseGraphicDimensions

(ab CIB format Version 5.6.251)

Nur für InputFormat JPG und PNG und wenn die Verarbeitung nicht im Speicher stattfindet.

Bei gesetzter Property bleiben die Original-Abmessungen der Grafik erhalten.

Mögliche Werte:

0    (Default) Bisheriges Verhalten bleibt erhalten, d.h. die Grafik wird skaliert und DINA4 hoch ausgegeben.

1    Bei der Ausgabe bleiben die Original-Abmessungen der Grafik erhalten.

Char*

Versiontext

Die Versionsnummer wird hier als Text abgefragt

Char*

Word6PositionFrame

Word6 abwärtskompatibel

Long (boolean)

WorkSpace

 

 

 

 

 

 

 

 

(ab CIB format Version 5.3.218):

Definitiert das Arbeitsverzeichnis für alle Dateinamensangaben.

Der Pfad wird als nullterminierte Zeichenkette angegeben. Der Pfad kann absolut angegeben werden oder relativ zum Arbeitsverzeichnis des aufrufenden Prozesses.

Alle Dateiangaben (ohne absoluten Pfad) in den Properties 'InputFilename' oder 'OutputFilename' oder bei INCLUDEPICTURE werden relativ zu diesem Workspace betrachtet.

Es kann auch eine Liste von Arbeitsverzeichnissen angegeben werden. Die einzelnen Angaben werden durch Semikolon getrennt. Für jede verwendete Datei wird eine Suche gestartet und die erste Fundstelle genutzt.

Wird nichts anderes angegeben, so wird der erzeugte Output im ersten Arbeitsverzeichnis der Liste abgelegt.

Char*

XHeight

Höhe

Long

XResolution

horizontale Auflösung

Long

YHeight

Breite

Long

YResolution

vertikale Auflösung

Long

 

Betriebssystemspezifische Properties

Nur Windows:

Optionname

OptionValue

Datentyp

Devmode