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 `WindowHeigth` muss zwingend gesetzt sein (gilt für Verwendung mit und ohne Views). Wenn der Inhalt die definierte WindowHeight überschreitet, wird automatisch eine Scrollleiste eingefügt.

Im Gegensatz zur oben definierten Konfiguration, werden im unteren Beispiel die Werte der Attribute WindowWidth und WindowHeight in den Globalen Konfigurationen ausgelagert:

<?xml version="1.0" encoding="utf-8"?>
<Configuration>
  <CustomContentSection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" WindowHeight="{[DocParam.WindowHeight]}" WindowWidth="{[DocParam.WindowWidth]}" Name="{U[DocParam.WindowName]}">
  <DataNodes>
      <!-- DataNodes werden hier definiert -->
    </DataNodes>
  </CustomContentSection>
  [...]
</Configuration>

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:

  <Elementname  Id="DocParam.Feldname"></Elementname>

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 `Tracked`-Attribut ist Voraussetzung.
Tooltip	Hinweis, der angezeigt, wenn der Benutzer mit der Maus darüber fährt, z. B. `Betreff für den Brief`. Wird von ValidationMessage überschrieben, falls diese gesetzt ist.
Tracked	Der Quick Check wird mit dem `Tracked` aktiviert. Ist der Wert auf `true` gesetzt, wird dem Benutzer im separaten Panel das Feld angezeigt. Sofern der Inhalt des Elementes leer ist, wird das Feld im Panel rot und nach der Bearbeitung grün angezeigt.

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 `Label` definiert wurde.

Beispiel/Simpel:

<Text Id="DocParam.Subject" />

Beispiel/Erweitert:

<Text Id="DocParam.Subject" Tooltip="Betreff für den Brief" Tracked="true" Label="Betreff">Einladung</Text>

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 mindestens ein Zeichen des Eingabetexts eine Ziffer sein muss. "Hallo 205" ist so beispielsweise eine gültige Eingabe.

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)
Online Tool zum erstellen von Regex

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.
Das Required-Attribut wird von der Validierung (Regex-Attribut) übersteuert, falls eine gesetzt wird.

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.

Beispiel/Simpel:

<DateTime Id="DocParam.Date" />

Beispiel/Erweitert - fixes Datum vorausgewählt:

<DateTime Id="DocParam.Date" Tooltip="Heutiges Datum" Tracked="true" Label="Datum" Format="dddd, dd. MMMM yyyy">2022-08-15</DateTime>

Beispiel/Erweitert - heute + 2 Tage (übermorgen) als vorausgewähltes Datum:

<DateTime Id="DocParam.Date" Tooltip="Heutiges Datum" Tracked="true" Label="Datum" Format="dddd, dd. MMMM yyyy" Offset="+2" />

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 `+2`, was "heute in 2 Tagen" bedeutet. Andere Möglichkeit: `-2` für "heute vor 2 Tagen". Dieses Attribut ist wirkungslos, wenn über den Element-Inhalt ein fixes Datum vorausgewählt.

CheckBox

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

Beispiele:

Dokument-Parameter