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

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:

Attribute der CustomContentSection:

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.

Basis-Attribute

Folgende Attribute können in jede Art von DataNode eingesetzt werden:

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:

Beispiele

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

DateTime

Wird in Word zu einem Datumsauswahl-Inhaltssteuerelement (Date Picker Content Control) mit Kalenderauswahl und wird auch im Dokument-Parameter so angezeigt.

Beispiele

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

CheckBox

Wird in Word als Kontrollkästchensteuerelement (Check Box Content Control) eingefügt und ist für eine ja/nein-Auswahl.

Beispiele

Inhalt

Wenn zwischen Start- und Endtag true gesetzt wird, ist die CheckBox beim Generieren bereits angekreuzt.

Attribute für CheckBox-Elemente

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

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

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

Open

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:

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.

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 Attribut IsVisible="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 Buttons

• TargetView: Id der Ziel-View bei Weiterleitungsbuttons

• Type: Spezial-Aktionen

  • Wert Submit: Dokument-Parameter-Dialog verlassen, weiter im Generierungsprozess

  • Wert Cancel: Dokument-Parameter-Dialog verlassen, Abbruch des Generierungsprozess

• IsDefault: Wenn auf true: 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.

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

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.

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.

CheckBox

→ Ein Auswahlkasten – oder eben eine CheckBox, siehe Abschnitt "CheckBox" im Kapitel DataNodes.

ComboBox

→ Eine Auswahlliste oder ein Dropdown, siehe Abschnitt "ComboBox" im Kapitel DataNodes.

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:

1. Die ComboBox definiert in der DataNode-Section

2. Die Combobox definiert in der View

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.

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:

Beispiel zur Veranschaulichung der Spalten:

Konfiguration:

Resultat (Spalten wurden markiert):

Open

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 oder Regex

  • "CheckBox": mit Required

• Formularelemente

  • "ComboBox": mit IsInvalidWhenValue

  • "RadioButton": bei Verknüpfung mit Text-Element mit Required. Mittels Attribut ShowRequiredIncicator wird bestimmt, wo das Warnhinweis-Icon angezeigt werden soll.

Beispiel:

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:

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:

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:

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.

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 dem Views-Element (siehe Beispiel oben)
  Bei diesen Funktionen muss entweder true oder false zurückgegeben werden:

  • true: Kein Validierungsfehler = Dokument-Parameter-Dialog wird verlassen

  • false: Validierungsfehler, Validierungsübersicht wird angezeigt = Dokument-Parameter-Dialog bleibt offen

• Über das OnChange-Attribut auf einem View-Wert-Control (z. B. auf einem TextBox-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

Dokument-Parameter mit Validierung

Simple Bindings

Calc-Bindings