Dokument-Parameter
- 1 Grundaufbau
- 2 CustomContentSection
- 3 DataNodes
- 3.1 Text
- 3.1.1 Beispiele
- 3.1.2 Inhalt
- 3.1.3 Attribute für Text-Elemente
- 3.2 DateTime
- 3.2.1 Beispiele
- 3.2.2 Inhalt
- 3.2.3 Attribute für DateTime-Elemente
- 3.3 CheckBox
- 3.3.1 Beispiele
- 3.3.2 Inhalt
- 3.3.3 Attribute für CheckBox-Elemente
- 3.4 ComboBox
- 3.4.1 Beispiele
- 3.4.2 Inhalt
- 3.4.3 Attribute des Item-Elements
- 3.4.4 Attribute für ComboBox-Elemente
- 3.5 Collection
- 3.1 Text
- 4 Views
- 4.1 Navigationsschalter ausserhalb von Rows
- 4.2 Rows und ihr Inhalt
- 4.2.1 Strukturelemente
- 4.2.2 Formularelemente
- 4.2.3 Validierung
- 4.3 Bindings
- 4.3.1 Simple Bindings
- 4.3.2 “Calc": Berechnungen in Bindings
- 4.4 Script – JavaScript
- 5 DataSources
- 6 Beispiele über alle Themen auf dieser Seite
In der Dokumentfunktion "Dokument-Parameter" kann die Eingabemaske konfiguriert werden, die beim Generieren eines Dokuments erscheint.
Die Konfiguration kann grob in drei Teile unterteilt werden:
DataNodes: In der "CustomContentSection" werden die Felder, sogenannte DataNode-Elemente, definiert.
View: Im Bereich der "View" wird das Aussehen des Dokument-Parameters festgelegt.
DataSources: In "DataSources" können Datenbankabfragen definiert und die Werte aus der Abfrage übernommen werden.
Grundaufbau
Grundaufbau
<Configuration>
<CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Name="Dokument-Parameter" WindowWidth="750" WindowHeight="750">
<DataNodes>
<!-- DataNode-Elemente werden hier definiert -->
</DataNodes>
</CustomContentSection>
<Views>
<View>
<!-- Hier wird das Aussehen des Dialoges definiert -->
</View>
</Views>
</Configuration>
Grundaufbau mit DataSources
<Configuration>
<CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Name="Dokument-Parameter" WindowWidth="750" WindowHeight="750">
<DataNodes>
<!-- DataNode-Elemente werden hier definiert -->
</DataNodes>
</CustomContentSection>
<Views>
<View>
<!-- Hier wird das Aussehen des Dialoges definiert -->
</View>
</Views>
<DataSources>
<SqlDataSource>
<!-- Hier kann die Datenbankabfrage konfiguriert werden -->
</SqlDataSource>
</DataSources>
</Configuration>
HINWEIS
Falls ein Grundaufbau angetroffen wird, bei dem das Views
-Element fehlt: siehe Veraltete Konfiguration.
CustomContentSection
Zuoberst bei den "DataNodes" werden die Elemente definiert, auf die in der "View" im unteren Teil zugegriffen wird. In der View wird das Aussehen des Dokument-Parameters festgelegt. Im DataSources-Part können Datenbank-Abfragen definiert werden, und die Werte aus der Abfrage auf die unter "DataNodes" definierten Elemente geschrieben werden.
Beispiel:
<CustomContentSection Name="Dokument-Parameter" WindowWidth="750" WindowHeight="750">
Attribute der CustomContentSection:
Attributname | Beschreibung |
---|---|
Name (Fenstername) | Hier wird der Name des Dokument-Parameter-Dialog-Fensters definiert werden. |
WindowWidth (Fensterbreite) | Hier kann die Fensterbreite in Pixel definiert werden. 1200 Pixel sollten nicht überschritten werden, da unter dieser Auflösung die einwandfreie Darstellung von primedocs möglich sein sollte. |
WindowHeight (Fensterhöhe) | Hier kann die Fensterhöhe in Pixel definiert werden. 1200 Pixel sollten nicht überschritten werden, da unter dieser Auflösung die einwandfreie Darstellung von primedocs möglich sein sollte. Der Wert für |
Im Gegensatz zur oben definierten Konfiguration, werden im unteren Beispiel die Werte der Attribute WindowWidth
und WindowHeight
in den Globalen Konfigurationen ausgelagert:
Dank dieser Auslagerung in die Globalen Konfigurationen wird gewährleistet, dass die genannten Informationen nur an einem Ort geändert werden müssen. Folglich werden Änderungen praktischerweise in allen Vorlagen angewendet, die diese Verknüpfung besitzen. Wenn in der Vorlage ein anderer Wert festgelegt werden muss, als derjenige in den Globale Konfigurationen, wird lediglich ein anderer Wert in die Anführungszeichen reingeschrieben.
DataNodes
In diesem Abschnitt geht es um die Konfiguration zwischen <DataNodes>
und </DataNodes>
. Jedes DataNode definiert ein Dokument-Parameter-Feld, auf das im Editor, in Skripten oder über Extended Bindings zugegriffen werden kann. Für jedes Feld, das in den Views existiert, muss für die Weiterverwendung ein DataNode angelegt werden.
Grundgerüst eines DataNodes:
Anstelle von "Elementname" können die untenstehenden DataNodes verwendet werden. Die Id ist in jedem Element zwingend und wird im Editormodus angezeigt und danach für die Verwendung im Editor, in Skripten oder in Extended Bindings benötigt. Die Id darf keine Leerzeichen enthalten und muss eindeutig sein.
HINWEIS
Wenn eine Id in den DataNodes doppelt vorhanden ist (NICHT in der View!), dann kann der Dokument-Parameter-Dialog nicht geöffnet werden.
Basis-Attribute
Folgende Attribute können in jede Art von DataNode eingesetzt werden:
Attributname | Beschreibung |
---|---|
Id | Ist in jedem Element zwingend. Sie wird benötigt, um das Feld zu identifizieren, es ins Dokument einzufügen und für die Verwendung in Skripten oder Extended Bindings. Die Id darf keine Leerzeichen enthalten und muss eindeutig sein. |
Label | Beschriftung des Elements in der primedocs-Funktion Quick Check-Panel in Word. Das |
Tooltip | Hinweis, der angezeigt, wenn der Benutzer mit der Maus darüber fährt, z. B. |
Tracked | Der Quick Check wird mit dem |
Text
Wird in Word als Nur-Text-Inhaltssteuerelement (Plain Text Content Control) eingefügt. In der View kann mit dem Text-Element auf eine Textbox, einen RadioButton, eine ComboBox oder eine CheckBox verwiesen werden. Je nach dem, welches der unteren Elemente eingesetzt wird, erscheint in Word im Textfeld etwas anderes:
In der View definiert | Beschreibung |
---|---|
TextBox | Im Inhaltssteuerelement erscheint der Text, der im Dokument-Parameter eingegebener wurde. |
RadioButton | Nur für Skripte und Extended Bindings geeignet; das Inhaltssteuerelement wird nicht ausgefüllt |
CheckBox | Nur für Skripte und Extended Bindings geeignet; Im Inhaltssteuerelement erscheint je nach dem "true" (CheckBox aktiviert) oder "false" (CheckBox deaktiviert) |
ComboBox | Im Inhaltssteuerelement wird abgefüllt, was in der View im Attribut |
Beispiele
Simpel:
Erweitert:
Inhalt
Wird zwischen Start- und Endtag etwas reingeschrieben, steht der eingegebene Text beim Generieren des Dokumentes bereits im Textfeld. Im erweiterten Beispiel z. B. Einladung
.
Attribute für Text-Elemente
Attributname | Beschreibung |
---|---|
Regex | Das Attribut erlaubt, einen Regex (.NET Syntax) zu definieren, der im eingegeben Text mindestens eine Übereinstimmung (Match) finden muss. Achtung: Falls der ganze Text übereinstimmen oder nur genau ein 'Match' vorhanden sein darf, muss dies vom Regex-Ausdruck definiert werden. Beispiele: Regex="^[0-9]+$" erzwingt, dass alle Zeichen des Eingabetexts Ziffern sein müssen und dass mindestens eine Ziffer vorhanden sein muss. (^ matcht den Anfang des Eingabetextes und $ das Ende) |
Required | Es definiert, ob das Feld leer gelassen werden darf (Required="false" oder nicht gesetzt) oder ob das Feld ausgefüllt werden muss (Required="true"). Solange das Textfeld nicht ausgefüllt wird, bleibt der OK-Button zum Bestätigen der Eingaben im Dokument-Parameter grau gefärbt und ist nicht anklickbar. Sobald die nötigen Zeichen im Textfeld abgefüllt sind, kann der OK-Button angeklickt werden. |
ValidationMessage | Falls Required="true" oder ein Validierungsregex gesetzt wurde, erlaubt ValidationMessage eine benutzerdefinierte Fehlermeldung, falls die Validierung fehlschlägt. Sie wird angezeigt, sobald der Mauszeiger über das rote Ausrufezeichen rechts im Textfeld schwebt. Falls ValidationMessage nicht gesetzt ist, wird im Fall einer Nichtübereinstimmung eine Standardmeldung angezeigt. |
DateTime
Wird in Word zu einem Datumsauswahl-Inhaltssteuerelement (Date Picker Content Control) mit Kalenderauswahl und wird auch im Dokument-Parameter so angezeigt.
Beispiele
Simpel:
Erweitert - fixes Datum vorausgewählt
Erweitert - heute + 2 Tage (übermorgen) als vorausgewähltes Datum
Inhalt
Wird zwischen Start- und Endtag das Datum gesetzt, ist dieses beim Öffnen vorausgewählt, wie z. B. 2022-08-15
für den Donnerstag, 15. August 2022. Wenn der Inhalt leer ist, wird jeweils das aktuelle Datum vorausgewählt.
Attribute für DateTime-Elemente
Attributname | Beschreibung |
---|---|
Calendar | Es setzt das Format des Kalenders. Default ist "Gregor". Dieses Attribut muss nicht zwingend gesetzt werden. |
Format | Definition des Datumformates z. B. "dd MM yyyy" für "02.06.2016", Liste mit Datumsformaten. In der Basis-Konfiguration der Globalen Übersetzungen sind mehrere Datumsformate hinterlegt, auf die zugegriffen werden kann. |
Offset | Hier kann mit Tagen das vorausgewählte Datum berechnet werden, ausgehend vom jeweils aktuellen Datum, z. B. mit |
CheckBox
Wird in Word als Kontrollkästchensteuerelement (Check Box Content Control) eingefügt und ist für eine ja/nein-Auswahl.
Beispiele
Simpel:
Erweitert:
Inhalt
Wenn zwischen Start- und Endtag true
gesetzt wird, ist die CheckBox beim Generieren bereits angekreuzt.
Attribute für CheckBox-Elemente
Attributname | Beschreibung |
---|---|
Required | Es definiert, ob das Feld leer gelassen werden darf (Required="false" oder nicht gesetzt) oder ob das Feld ausgefüllt werden muss (Required="true"). Solange das Textfeld nicht ausgefüllt wird, bleibt der OK-Button zum Bestätigen der Eingaben im Dokument-Parameter grau gefärbt und ist nicht anklickbar. Sobald die nötigen Zeichen im Textfeld abgefüllt sind, kann der OK-Button angeklickt werden. |
ComboBox
Wird in Word als Kombinationsfeld-Inhaltssteuerelement (Combo Box Content Control), auch genannt Dropdown, eingefügt. Es ist für die Auswahl zwischen vorgegebenen Werten (es sind beliebige Eingaben in Word zulässig).
Beispiele
Simpel:
Erweitert:
Inhalt
Als Inhalt können Item
-Elemente definiert werden. Jedes Item steht dem Benutzer als Eintrag im Kombinationsfeld zur Auswahl. Auf den Value
des Items wird in Skripten zugegriffen.
Attribute des Item
-Elements
DisplayText
Anzeigetext in Dokument-Parameter-Dialog und Kombinationsfeld-Inhaltssteuerelementen in Word.
Gilt generell als Inhalt dieses primedocs-Felds, so z. B. bei einem Zugriff in Skripten mit
<Element id="DocParam.ReasonForCongratulation " />
.Wird in Skripten für Conditions verwendet, wenn vor der Id kein
$
-Zeichen steht.
Beim obigen Beispiel ist<Condition when="DocParam.ReasonForCongratulation = 'Mitarbeiterjubiläum'>
also wahr.
Value
Darf nicht leer sein – es muss mindestens ein Zeichen enthalten sein. Es sollte keine Leerzeichen oder Sonderzeichen enthalten sein, da Word diese nicht akzeptiert.
Wird in Skripten für Conditions verwendet, wenn vor der Id ein
$
-Zeichen steht.
Beim oberen Beispiel ist<Condition when="$DocParam.ReasonForCongratulation = 'employeeAnniversary'>
also wahr.
Attribute für ComboBox-Elemente
Attributname | Beschreibung |
---|---|
IsEditable | Wenn es auf |
IsSearchEnabled | Wenn es auf |
SelectedValue | Bestimmt, welcher Eintrag im Kombinationsfeld vorausgewählt ist. Dabei muss vom |
Collection
Der Collection-DataNode ist eine Funktionserweiterung der ComboBox. Wie der Name schon sagt, ist eine Collection eine Sammlung an Werten. Der Unterschied der Wertesammlung in einer Collection und in einer ComboBox unterscheiden sich darin, dass die Collection komplexe Datenstrukturen speichern kann, während die ComboBox nur eine einfache Key → Value Zuordnung zulässt. Beispiel:
Eine Collection enthält also eine beliebige Anzahl Elemente, die wiederum beliebig viele Text-Elemente enthalten. Diese Text-Elemente sind mit einer Id eindeutig gekennzeichnet. Eine Collection dient als Datengrundlage für eine ComboBox.
Da die Collection mehrere Werte pro Einträge speichert, wird noch eine entsprechende Abbildungsmöglichkeit für diese Werte benötigt. Für das Speichern der Werte werden die bereits bekannten DataNodes (in der CustomContentSection) nach dem bekannten Schema definiert:
Die Namensgebung kann frei gewählt werden. In diesem Beispiel wurde der Übersicht wegen die Id als Präfix verwendet. Somit kann basierend auf dieser Collection und den DataNodes folgende ComboBox in den Views definiert werden:
Die Id der ComboBox ist identisch mit derjenigen der Collection. Wie bei anderen DataNodes, wird so die Verbindung zwischen dem definierten DataNode und dem entsprechenden View-Element hergestellt. Der CollectionLabelMember gibt an, welches Text-Element der Elemente in der Collection in der ComboBox zur Auswahl angezeigt werden soll, in diesem Beispiel also der Name des Mitarbeiters. Die ComboBox wird im Dialog folgendermassen dargestellt
Das CollectionSelectionMap definiert, welcher Text des ausgewählten Elementes aus der Collection (Source) auf welchen DataNode (Target) geschrieben wird. Wird ein Eintrag ausgewählt, werden die Werte des ausgewählten Eintrages gemäss den definierten CollectionSelectionMap auf die DataNodes geschrieben und können dann nach bekanntem Schema verwendet werden.
Die komplette Konfiguration sieht nun so aus:
Wann kommen Collections zur Anwendung?
Collections kommen vor allem dann zur Anwendung, wenn eine Auswahl existiert, von welcher mehrere Werte direkt abhängen. Das kann auch mit ComboBoxen ohne Collections erreicht werden, allerdings ist ohne Collection die Wartung aufwändiger.
Beispiel:
Wir haben eine ComboBox "Land" mit der folgenden Auswahl: Schweiz Deutschland Österreich Dann gibt es noch zwei weitere Felder, Währung und Hauptstadt, die von der Auswahl in der ComboBox abhängig sind. Die Zuordnung sieht folgendermassen aus:
Land | Waehrung | Haupstadt |
---|---|---|
Schweiz | CHF | Bern |
Deutschland | Euro | Berlin |
Österreich | Euro | Wien |
Die Konfiguration ohne Collections
Die ComboBox:
Die abhängigen Felder (als Skripte):
Hier wird direkt ersichtlich; muss ein neues Land hinzugefügt werden, muss in diesen beiden Skripten auch der Abgleich bzw. eine Condition ergänzt werden.
Die Konfiguration mit Collections
Wenn mit dieser Konfiguration ein Land zur Auswahl hinzukommt, muss lediglich der Eintrag in der Collection ergänzt werden.
HINWEIS
Es gibt zwei Arten von DataNodes: DataNodes und ViewDataNodes. Die DataNodes werden innerhalb der CustomContentSection definiert, die ViewDataNodes direkt nach dem Views
-Element. Im XML heissen beide gleich; DataNodes.
Der massgebende Unterschied zwischen den DataNodes und den ViewDataNodes ist, dass die ViewDataNodes nur im Dokument-Parameter existieren. Beim Generieren des Dokumentes werden diese dann entfernt. Wird der Dokument-Parameter aus dem Dokument nochmals geöffnet, so werden die Daten erneut aus der Konfiguration der Vorlage geladen, nicht aus dem Word-Dokument selbst. Die DataNodes werden hingegen mit ins Dokument übernommen. Die ViewDataNodes sind besonders geeignet, wenn mit grossen Collections gearbeitet wird. Die nicht ausgewählten Einträge werden nicht ins Dokument übernommen. So werden viel weniger Daten mitgenommen.
Views
Innerhalb vom Views
-Start- und Endtag befinden sich einzelne View
-Strukturen. Eine View ist eine Ansicht, welche Texte, Bilder, Eingabemöglichkeiten (Textboxen, Checkboxen, Komboboxen, ...) und Buttons enthält.
Es ist dabei möglich, mehrere View
-Strukturen zu definieren. Der Benutzer kann durch das Klicken auf Buttons (i. d. R. "Weiter" und "Zurück") die View wechseln.
Grundaufbau
Es können beliebig viele View Elemente erstellt werden.
In einer View können beliebig viele Row Elemente enthalten sein.
Eine View hat im Standardfall 4 Spalten (Columns). Mit dem Attribut
Columns
kann die Spaltenanzahl jedoch auch auf 1, 2, 3, 4, 6 oder 12 gesetzt werden.Möchte man keinen Dokument-Parameter-Dialog anzeigen, sondern z. B. nur über den Quick Check Dokument-Parameter konfigurieren, kann auf Ebene des
Views
-Element das AttributIsVisible="false"
setzen.
Nur eine View:
Mehrere Views:
Spezial-Id: main
: Diese View ist die Startansicht. Es muss in jedem Fall eine View mit der Id main
konfiguriert werden.
Navigationsschalter ausserhalb von Rows
Attribute für Buttons:
Label
: Beschriftung des ButtonsTargetView
: Id der Ziel-View bei WeiterleitungsbuttonsType
: Spezial-AktionenWert
Submit
: Dokument-Parameter-Dialog verlassen, weiter im GenerierungsprozessWert
Cancel
: Dokument-Parameter-Dialog verlassen, Abbruch des Generierungsprozess
IsDefault
: Wenn auftrue
: Bestimmt die Standard-Aktion bei Enter
Rows und ihr Inhalt
Neben Buttons beinhalten die Views auch Rows (Zeilen). Die Rows enthalten den eigentlichen Inhalt der View und in diese können Struktur- und Formularelemente eingefügt werden. Die Strukturelemente gelten rein zum Anpassen des Aussehens des Dokument-Parameters. Die Formularelemente sind zum Einfügen in die Vorlage oder zum Einsetzen in Skripten und Extended Bindings.
Attribute der Struktur- und Formularelemente:
Die Views sind standardmässig in 4 Spalten (Columns) unterteilt. Jedes Struktur- und Formularelement hat die Breite 1. Um die Breite zu vergrössern, wird das Attribut ColumnSpan
verwendet. Die Struktur- und Formularelemente werden von links nach rechts eingefügt. Wenn ein Feld um eine Spalte versetzt angezeigt werden soll, wird das mit ColumnOffset="1"
bewerkstelligt.
Folgende Attribute können sowohl bei Strukturelementen als auch bei Formularelementen eingesetzt werden.
Attributname | Beschreibung |
---|---|
Bind | Ermöglicht das Anzeigen und Verschwinden lassen von Rows oder Elementen, siehe Kapitel Bindings. |
ColumnOffset | Gibt an, wieviele Spalten vor dem Feld übersprungen werden sollen (also die Anzahl "Einzüge") |
ColumnSpan | Gibt an, wieviele Spalten das Feld beansprucht. Das kann je nach Spaltenanzahl bis zu Anzahl 12 sein. Wird nichts angegeben, ist es der Wert 1. |
IsEnabled | Wenn |
IsVisible | Wenn |
OnChange | Wird als Referenz auf ein Element im Zusammenhang mit JavaScript im Dokument-Parameter verwendet. Siehe dazu das Kapitel JavaScript. |
Tooltip | Angezeigter Text, wenn der Cursor über diesem Feld ist. |
AccessibilityText | Definierter Text für Screen Reader. Wenn dieses Attribut gesetzt wird und der Client mit |
AccessibilityReadContent |
|
Value | Vordefinierter Text. Der Inhalt wird jedoch ignoriert, sobald es schon vordefinierten Text im gleichen Element in der DataNode-Section gibt. |
Spezialfall Attribut Id
:
Die Id wird bei allen Formularelementen benötigt. Bei Strukturelementen ist sie obsolet. Sie identifiziert das in den DataNodes festgelegte Feld.
Strukturelemente
Strukturelement | Beschreibung |
---|---|
TextBlock |
|
Separator |
|
Label |
|
Image |
|
ImagePicker | Der ImagePicker ermöglicht das Auswählen von Bildern im Datei-Explorer des Benutzers. Das dazugehörige DataNode zum Einfügen in das Dokument ist das Image-Element. |
Beispiel mit Strukturelementen
Formularelemente
Wenn es ein DataNode mit der gleichen Id gibt, wird versucht, dieses als Datenquelle zu nutzen. Diese Felder besitzen alle ein Value
-Attribut, das als initialer Wert genutzt wird.
TextBox
→ Ein- oder mehrzeiliges Textfeld, siehe Abschnitt "Text" im Kapitel DataNodes.
Mögliche Attribute | Beschreibung |
---|---|
Lines | Anzahl an Zeilen im Textfeld: wenn das |
Mask | Eingabe-Maske: sie erleichtert die Eingabe von vielen Zahlen, zum Beispiel einer AHV-Nummer (Mask="000.0000.0000.00"). '0' → Zahl; erforderlich, damit der Dokument-Parameter mit OK bestätigt und das Dokument generiert werden kann. '9' → Zahl; nicht erforderlich. Der Dokument-Parameter kann auch ohne Eingabe bestätigt werden. Für die Syntax und mehr Möglichkeiten, siehe hier: Supported Masks |
Beispiel für Mask:
In diesem Beispiel werden die ersten 6 Ziffern verlangt. Werden keine 6 eingegeben, kann der Dokument-Parameter nicht bestätigt werden. Die letzte Ziffer ist jedoch freiwillig.
Vordefinierter Text:
Es gibt zwei Arten, einen Text im Textfeld vorzudefinieren: entweder über das Value
-Attribut in den Views...
...oder über die Eingabe bei den DataNodes zwischen dem Start- und Endtag:
Der vordefinierte Textfeld-Inhalt darf jeweils nur an einem Ort definiert werden. Sind an beiden Orten sichtbare Zeichen definiert, wird der Value des in den DataNodes definierten Text-Elements eingefügt. Der Value in den Views wird folglich ignoriert.
DatePicker
→ Datumsauswahl mit Kalender, siehe Abschnitt "DateTime" im Kapitel DataNodes.
Mögliche Attribute | Beschreibung |
---|---|
Format | siehe "Attribute für DateTime-Elemente" im Kapitel DataNodes. |
CheckBox
→ Ein Auswahlkasten – oder eben eine CheckBox, siehe Abschnitt "CheckBox" im Kapitel DataNodes.
Mögliche Attribute | Beschreibung |
---|---|
Label | Bezeichnung, die rechts von der CheckBox erscheint. |
ComboBox
→ Eine Auswahlliste oder ein Dropdown, siehe Abschnitt "ComboBox" im Kapitel DataNodes.
Mögliche Attribute | Beschreibung |
---|---|
IsInvalidWhenValue | Wenn die festgesetzte Option diesen Wert hat, ist das Control nicht "gültig", d. h. man kann das Dokument nicht erzeugen. |
CollectionLabelMember | Wird im Zusammenhang mit Collections verwendet, siehe dazu Kapitel Collections |
CollectionPlaceholder | Wird im Zusammenhang mit Collections verwendet, siehe dazu Kapitel Collections |
Die Werte für die ComboBox können entweder im DataNode oder in der View definiert werden. Die Auswahlmöglichkeiten für die ComboBox können entweder im DataNode-Element vom Typ ComboBox definiert werden oder in der View. Die Auswahlmöglichkeiten werden aus dem DataNode-Element übernommen, auch wenn in der View eine Liste definiert wurde. Wenn die Liste in der View definiert wird, dann muss das DataNode-Element vom Typ Text sein. Hier eine Übersicht:
Die ComboBox definiert in der DataNode-Section
1a) ComboBox-Element in der DataNode-Section
Attribute innerhalb der DataNode-ComboBox | Beschreibung |
---|---|
Item | Element, das eine Option für in das Dropdown-Feld eröffnet. |
Item → Value | Wert, auf welchen mittels Skripten zugegriffen wird. |
Item → DisplayText | Bezeichnung, die im DropDown, im Dokument-Parameter sowie im Word ausgegeben wird. |
1b) Zugriff auf das ComboBox-Element in der View
2. Die Combobox definiert in der View
2a) Text-Element in der DataNode-Section
2b) Zugriff auf das Text-Element in der View
Attribute innerhalb der View-ComboBox | Beschreibung |
---|---|
ComboBox → Value | Es hat die gleiche Funktion wie das Attribut |
Item → Value | Wert, auf welchen mittels Skripten zugegriffen wird. |
Item → Label | Bezeichnung, die im DropDown, im Dokument-Parameter sowie im Word ausgegeben wird. |
RadioButton
RadioButtons werden über ihre Id gruppiert. Alle RadioButtons mit derselben Id stellen eine "Entweder-Oder-Auswahl" dar.
Pro anwählbare Option, muss also ein einzelnes RadioButton-Element definiert werden. Die Id ist dabei die Id des Datanodes, also des Text- oder ComboBox-Elementes. Die zwei Attribute Label
und Value
sind zwingend.
Mögliche Attribute | Beschreibung |
---|---|
Value | Wert, der ins DataNode-Element abgefüllt wird, wenn dieser RadioButton ausgewählt ist und auf den mittels Skripten zugegriffen wird. |
Label | Bezeichnung, die im Dokument-Parameter rechts vom Button erscheint |
Da es in Word keine RadioButton-Inhaltssteuerelemente gibt, gibt es auch kein RadioButton-DataNode in primedocs. Deswegen werden RadioButtons vor allem im Zusammenhang mit Textbaustein-Skripten verwendet. Als DataNode werden der Text-DataNode oder der ComboBox-DataNode verwendet:
Definition eines RadioButtons mit einem Text-Element (empfohlen):
Hier wird der RadioButton im Text-Element gespeichert. Diese Variante ist geeignet, wenn der Wert in Skripten oder Extended Bindings verwendet werden soll. Falls ein RadioButton vorausgewählt sein soll, muss der Value des entsprechenden RadioButtons als Standard-Text konfiguriert werden. Im Beispiel unten ist also jetzt der RadioButton mit "Frau" vorausgewählt.
TextNode in der DataNode-Section:
In der View:
Definition eines RadioButtons mit einem ComboBox-Element:
In diesem Fall wird der RadioButton im ComboBox-Element gespeichert. Der Value in der ComboBox muss dabei der Value im RadioButton in der View entsprechen. Diese Variante ist geeignet, wenn der Wert im Dokument ausgegeben werden soll, da die Anzeige im Dokument über den Value des ComboBoxNode-Eintrags gesteuert wird. Falls ein RadioButton vorausgewählt sein soll, muss der Value des entsprechenden RadioButtons im SelectedValue
-Attribut der ComboBoxNode konfiguriert werden.
ComboBoxNode in der DataNode-Section:
In der View:
Beispiel zur Veranschaulichung der Spalten:
Konfiguration:
Resultat (Spalten wurden markiert):
Validierung
Benutzereingaben können, wie erwähnt, validiert werden. Wenn eines oder mehrere Felder dementsprechend markiert werden, kann der Benutzer den Dokument-Parameter-Dialog nicht verlassen, bevor er die Bedingungen erfüllt hat.
Übersicht über alle Validierungsmöglichkeiten:
DataNode-Elemente
"Text": mit
Required
oderRegex
"CheckBox": mit
Required
Formularelemente
"ComboBox": mit
IsInvalidWhenValue
"RadioButton": bei Verknüpfung mit Text-Element mit
Required
. Mittels AttributShowRequiredIncicator
wird bestimmt, wo das Warnhinweis-Icon angezeigt werden soll.
Beispiel:
Aussehen des Dialoges
Konfiguration
Bindings
Simple Bindings
Bindings beziehen sich auf andere Werte und können diese als "Wert-Grundlage" und für Abfragen nutzen. Über Bindings können folgende Attribute gesteuert werden:
Mögliche Attribute | Beschreibung |
---|---|
IsEnabled | Gilt für alle Elemente. Definiert, ob das Feld benutzt werden darf (Text erfassen in einer Textbox, CheckBox anklicken, aus einer ComboBox etwas auswählen etc.) |
IsVisible | Gilt für alle Elemente. Definiert, ob ein Feld sichtbar ist. |
Value | Gilt für alle Elemente, die einen Wert vorweisen, also nicht für Buttons. Indem man es "bindet", kann ein Wert eines Feldes auf ein anderes Feld übertragen werden. |
TargetView | Wird bei Buttons eingesetzt zum zur nächsten View zu gelangen. |
IsVisible-Beispiel:
Der Button mit der Bezeichnung "Notizen >" wird nur im Dokument-Parameter angezeigt, wenn es einen Wert "DocParam.Erweitert" = "true" (also eine aktivierte CheckBox) gibt. IsEnabled funktioniert gleich.
TargetView-Beispiel:
Value-Bind-Beispiel:
Werte können auch an Controls gebunden werden um z. B. bei der letzten Seite eine Übersicht der eingegeben Daten anzuzeigen:
Anstatt einzelne Elemente können auch ganze Rows gebindet werden:
Row-Beispiel:
Vergleichsoperatoren der Bindings:
Operator | Beschreibung |
---|---|
| ungleich, gilt für Text und Zahlen. |
| gleich, gilt für Text und Zahlen |
| grösser als (XML-Attribute erlauben keine < oder >, daher muss |
| grösser oder gleich |
| kleiner als |
| kleiner oder gleich |
Mehrere Bedingungen können mit UND oder ODER verknüpft werden:
||
für ODER&&
für UND (steht für &&) (XML-Attribute erlauben keine "&", daher muss&
verwendet werden)
Es können auch mehrere Bindings mit einem ,
getrennt angegeben werden:
“Calc": Berechnungen in Bindings
Die Wertgrundlagen für die Bindings können mit mathematischen Funktionen erweitert werden. Das Ansprechen der Felder bleibt dabei gleich ($('DocParam.Xyz')
). Um die Felder mathematisch miteinander zu verknüpfen, können die normalen Basisoperatorn (+
, -
, /
, *
) verwendet werden.
Übersicht über alle möglichen Operatoren und wie sie verwendet werden:
Operator | Beschreibung |
---|---|
Basis-Operatoren wie | |
Standard-Funktionen wie Quadratwurzel, sin, tan, cos, etc. | |
| |
Weitere Funktionen |
|
Jeder Calc-Aufruf enthält als abschliessendes Argument den Formatierungs-String, vom Term separiert durch ein ;
. Dieser Wert kann weggelassen werden (die umschliessenden ''
jedoch nicht). Das ;
ist zwingend.
Formatierung:
N2 → Zahl mit zwei Nachkommastellen (Standard)
C2 → Währungsformat entsprechend der aktuell ausgewählten Dokumentsprache mit zwei Nachkommastellen
Komplette Liste mit Formatierungscodes: https://docs.microsoft.com/de-de/dotnet/standard/base-types/standard-numeric-format-strings
Syntax:
Die verwendete Library ist fähig, Exponent-vor-Punkt-vor-Strich zu rechnen. → ( a + b * c) == (a + (b * c)) != ((a + b ) * c)
. Beim Calc
-Schlüsselwort spielt die Gross- und Kleinschreibung keine Rolle.
Beispiele
Value-Bind:
IsVisible-Bind:
Weiter bietet Calc die Möglichkeit, angewählte CheckBoxen zu "zählen":
Der bool'sche "Checked"-Value der Checkbox wird von Calc in einen Integer mit Wert 0 für false (= nicht angewählt) und 1 für true (= angewählt) umgewandelt, sodass die Werte zusammengerechnet werden können. Das obige Beispiel steht für: "Wenn zwei der Checkboxen 1 bis 4 angewählt sind, dann zeige die Row mit dem Label an." Dabei muss auf die Formatierung geachtet werden: Zwingend ohne Kommastellen, denn 1.00
ist nicht gleich 1
, und kann dementsprechend nicht in einen bool'schen Wert zurückgewandelt werden.
Sofern keine Standardwerte in den DataNode-Elementen vorgegeben sind, werden alle Calc-Binding-Werte mit 0
initialisiert. Insbesondere bei "IsEnabled"- und "IsVisible"-Bindings mit "Calc"-Bedingungen sollte man auf valide Standardwerte achten, ansonsten ist die Bedingung initial immer erfüllt.
Script – JavaScript
Für Anforderungen, die mit den üblichen Konfigurationen nicht abgedeckt werden können, bietet die Dokument-Parameter-Dokumentfunktion die Möglichkeit, JavaScript zu schreiben.
Grundaufbau mit JavaScript
The Script
element is inserted at the following position:
JavaScript-Beispiel
Komplettes Beispiel, das die Möglichkeiten der JavaScript-Integration aufzeigt:
Innerhalb des Script
-Elements können JavaScript-Funktionen definiert werden. Erlaubt ist gültiges ECMAScript 5.1.
Für die Verwendung dieses Features sind JavaScript-Kenntnisse vorausgesetzt. Die Grundlagen von JavaScript sind in dieser Dokumentation nicht aufgeführt.
Für den Aufruf der Funktionen gibt es zwei Möglichkeiten:
Über das
OnSubmit
-Attribut auf demViews
-Element (siehe Beispiel oben)
Bei diesen Funktionen muss entwedertrue
oderfalse
zurückgegeben werden:true
: Kein Validierungsfehler = Dokument-Parameter-Dialog wird verlassenfalse
: Validierungsfehler, Validierungsübersicht wird angezeigt = Dokument-Parameter-Dialog bleibt offen
Über das
OnChange
-Attribut auf einem View-Wert-Control (z. B. auf einemTextBox
-Control; siehe Beispiel oben)
Bei diesen Funktionen ist kein Rückgabewert nötig.
Für die Interaktion mit DataNode-Elementen kann das OO
-Objekt wie folgt verwendet werden:
OO.getValue("ANY_ID")
: Gibt den Text-Wert des DataNode-Elements mit der entsprechenden Id zurück. Beispiel:var valueFromExampleDocParam = OO.getValue("DocParam.Example");
OO.setValue("ANY_ID", "ANY_VALUE")
: Setzt den Text-Wert des DataNode-Elements mit der entsprechenden Id. Beispiel:OO.setValue("DocParam.Example", "Neuer Inhalt...");
OO.addValidationMessage("ANY_ID", "ANY_VALIDATION_MESSAGE")
: Setzt einen Validierungsfehler mit einer Nachricht für das DataNode-Element mit der entsprechenden Id. Hinweis: Alle Validierungsnachrichten werden in der Validierungsübersicht angezeigt. Wenn ein Element mit der angegebenen ID gefunden wird, wird ein Fehlerhinweis angezeigt. Beispiel:OO.addValidationMessage("DocParam.Example", "Wenn X und Y gesetzt wurden, muss im Beispielfeld etwas eingegeben werden.");
DataSources
Das DataSources-Feature ist auf dieser Seite dokumentiert.
Beispiele über alle Themen auf dieser Seite
Einfache Dokument-Parameter-Dialog Konfiguration
Konfiguration
Verhalten des Dialoges
Dokument-Parameter mit Validierung
Konfiguration
Verhalten des Dialoges
Simple Bindings
Konfiguration
Verhalten des Dialoges
Calc-Bindings
Konfiguration
Verhalten des Dialoges
PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland