Forms

Grundaufbau

<FormsConfiguration>
  <Elements>
    <!-- Formularelemente und Gruppen hier einfügen -->
  </Elements>
</FormsConfiguration>

Strukturelemente

Gruppen

Formularelemente können mit <Group>...</Group> für die visuelle Darstellung gruppiert werden.

<FormsConfiguration>
  <Elements>
    <!-- [Formularelemente] -->
    <Group Title="Telefonnummern">
      <!-- [Formularelemente] -->
    </Group>
    <!-- [Formularelemente] -->
  </Elements>
</FormsConfiguration>

Gruppen dürfen nicht weitere Gruppen enthalten (keine Verschachtelung).

Attribute für Group:

Attributname	Beschreibung
`Title` (optional)	Titel, der auf der Eingabeoberfläche angezeigt wird.

Info

Wird dem Benutzer auf der Eingabeoberfläche angezeigt. Der anzuzeigende Text wird als Inhalt des Info-Elements angegeben.

Beispiel:

<Info>Wichtig: Jedes Protokoll muss auch im Teams-Kanal «Protokollfeed» gesendet werden.</Info>

Formularelemente

Text

Wird in Word als Nur-Text-Inhaltssteuerelement (Plain Text Content Control) eingefügt.
Bietet dem Benutzer die Möglichkeit, in der Eingabeoberfläche einen Text einzugeben.
Typische Ausprägung in der Benutzeroberfläche: Textfeld

Beispiele:

Simpel
Erweitert

<Text Id="Subject" Label="Betreff" />

<Text Id="Subject" Label="Betreff" Value="Protokoll für" MultiLine="true" Required="true">
  <Description>Bitte treffenden Betreff eingeben, der das Anliegen kurz, prägnant und präzise beschreibt.</Description>
  <ValidationMessage>Bitte einen Betreff eingeben.</ValidationMessage>
</Text>

Attribute für Text:

Attributname	Beschreibung
`Id` (erforderlich)	Wird zur Identifikation benötigt (Einfügen in der Vorlage, Verwendung in Skripten). Darf keine Leerzeichen enthalten und muss eindeutig sein. Forms fügt automatisch den Präfix `Forms.` hinzu (aus `Subject` wird z. B. `Forms.Subject`).
`Label` (erforderlich)	Beschriftung des Elements in der Eingabeoberfläche
`Value` (optional)	Vordefinierter Text, den der Benutzer bearbeiten kann
`MultiLine` (optional)	Wenn `true`: Möglichkeit in der Eingabeoberfläche, Zeilenumbrüche einzufügen
`Required` (optional)	Wenn `true`: Der Benutzer muss eine Eingabe tätigen, der Text darf nicht leer sein und nicht nur aus Leerzeichen bestehen. Empfohlen: Zusätzlich eine spezifische `ValidationMessage` konfigurieren.

Inhalte für Text:

Elementname	Beschreibung
`Description` (optional)	Zusätzliche Informationen für den Benutzer, der das Formular ausfüllt. Wird in der Eingabeoberfläche angezeigt (evtl. als Tooltip).
`ValidationMessage` (optional)	Text, der dem Benutzer angezeigt wird, wenn dieses Textfeld ungültig ausgefüllt wurde.

YesNo

Wird in Word als Kontrollkästchensteuerelement (Check Box Content Control) eingefügt
Bietet dem Benutzer die Möglichkeit, in der Eingabeoberfläche eine Option zu aktivieren ("Ja") oder zu deaktivieren ("Nein")
Typische Ausprägung in der Benutzeroberfläche: Checkbox

Beispiele:

Simpel
Erweitert

<YesNo Id="MustBeSigned" Label="Muss unterzeichnet werden" />

<YesNo Id="MustBeSigned" Label="Muss unterzeichnet werden" Value="false" RequiredValue="true">
  <Description>Anwählen, wenn das Protokoll von Hand unterzeichnet werden muss</Description>
  <ValidationMessage>Protokolle müssen immer unterzeichnet werden.</ValidationMessage>
</YesNo>

Attribute für YesNo:

Attributname	Beschreibung
`Id` (erforderlich)	Wird zur Identifikation benötigt (Einfügen in der Vorlage, Verwendung in Skripten). Darf keine Leerzeichen enthalten und muss eindeutig sein. Forms fügt automatisch den Präfix `Forms.` hinzu (aus `MustBeSigned` wird z. B. `Forms.MustBeSigned`).
`Label` (erforderlich)	Beschriftung des Elements in der Eingabeoberfläche
`Value` (optional)	Wenn `true`: Die YesNo-Option ist zu Beginn aktiviert
`RequiredValue` (optional)	Wenn `true`: Der Benutzer muss die YesNo-Option aktivieren. Wenn `false`: Der Benutzer muss die YesNo-Option deaktivieren. Empfohlen: Zusätzlich eine spezifische `ValidationMessage` konfigurieren.

Inhalte für YesNo:

Elementname	Beschreibung
`Description` (optional)	Zusätzliche Informationen für den Benutzer, der das Formular ausfüllt. Wird in der Eingabeoberfläche angezeigt (evtl. als Tooltip).
`ValidationMessage` (optional)	Text, der dem Benutzer angezeigt wird, wenn diese YesNo-Option ungültig ausgefüllt wurde.

Date

Wird in Word als Datumsauswahl-Inhaltssteuerelement (Date Picker Content Control) eingefügt
Bietet dem Benutzer die Möglichkeit, in der Eingabeoberfläche ein Datum auszuwählen
Typische Ausprägung in der Benutzeroberfläche: Datepicker

Beispiele:

<Date Id="CreationDate" Label="Erstelldatum" Format="dd.MM.yyyy" />

<Date Id="CreationDate" Label="Erstelldatum" Format="dd.MM.yyyy" Value="2020-12-31" Required="true">
  <Description>Optimalerweise sollte hier das Datum des Postversands gewählt werden.</Description>
  <ValidationMessage>Bitte ein Erstelldatum auswählen.</ValidationMessage>
</Date>

<Date Id="CreationDate" Label="Erstelldatum" Format="dd.MM.yyyy" RelativeDate="FirstDayOfMonth" OffsetMonths="2" OffsetDays="-1"  />

Attribute für Date:

Attributname	Beschreibung
`Id` (erforderlich)	Wird zur Identifikation benötigt (Einfügen in der Vorlage, Verwendung in Skripten). Darf keine Leerzeichen enthalten und muss eindeutig sein. Forms fügt automatisch den Präfix `Forms.` hinzu (aus `CreationDate` wird z. B. `Forms.CreationDate`).
`Label` (erforderlich)	Beschriftung des Elements in der Eingabeoberfläche
`Format` (erforderlich)	Definition des Datumformates, z. B. `dd.MM.yyyy` für "31.12.2020" oder `d. MMMM yyyy` für "31. Dezember 2020". Siehe Liste mit Datumsformaten. In der Basis-Konfiguration befinden sich in den globalen Übersetzungen mehrere Datumsformate, auf die zugegriffen werden kann.
`Required` (optional)	Wenn `true`: Der Benutzer muss ein Datum auswählen, das Datum darf nicht leer sein. Empfohlen: Zusätzlich eine spezifische `ValidationMessage` konfigurieren.
`Value` (optional)	Vorausgewähltes fixes Datum, das der Benutzer bearbeiten kann. Format: `yyyy-MM-dd`, z. B. `2020-12-31` Kann nicht in Kombination mit `RelativeDate` verwendet werden.
`RelativeDate` (optional)	Vorausgewähltes Datum, das der Benutzer bearbeiten kann und das relativ zum Zeitpunkt der Dokumenterstellung ist. Wenn `Today`: Datum der Dokumenterstellung Wenn `FirstDayOfMonth`: Erster Tag des Monats der Dokumenterstellung Wenn `FirstDayOfYear`: Erster Tag des Jahres der Dokumenterstellung Die Attribute `OffsetMonths` und `OffsetDays` können verwendet werden, um das relative Datum weiter anzupassen. Beispiele: Aktueller Tag: `RelativeDateOption="Today"` Erster Tag des aktuellen Monats: `RelativeDateOption="FirstDayOfMonth"` Letzter Tag des vorherigen Monats: `RelativeDateOption="FirstDayOfMonth" OffsetDays="-1"` Letzter Tag des aktuellen Monats: `RelativeDateOption="FirstDayOfMonth" OffsetMonths="1" OffsetDays="-1"` Letzter Tag des vorherigen Jahres: `RelativeDateOption="FirstDayOfYear" OffsetDays="-1"` Letzter Tag des aktuellen Jahres: `RelativeDateOption="FirstDayOfYear" OffsetMonths="12" OffsetDays="-1"`
`OffsetMonths` (optional)	Anzahl Monate, die zum relativen Datum dazuaddiert werden (positive und negative Zahlen erlaubt). Siehe `RelativeDateOption`.
`OffsetDays` (optional)	Anzahl Tage, die zum relativen Datum dazuaddiert werden (positive und negative Zahlen erlaubt). Siehe `RelativeDateOption`.

Inhalte für Date:

Elementname	Beschreibung
`Description` (optional)	Zusätzliche Informationen für den Benutzer, der das Formular ausfüllt. Wird in der Eingabeoberfläche angezeigt (evtl. als Tooltip).
`ValidationMessage` (optional)	Text, der dem Benutzer angezeigt wird, wenn dieses Datumsfeld ungültig ausgefüllt wurde.

Choice

Wird in Word als Kombinationsfeld-Inhaltssteuerelement (Combo Box Content Control) eingefügt
Bietet dem Benutzer die Möglichkeit, in der Eingabeoberfläche zwischen verschiedenen Optionen auszuwählen
Typische Ausprägung in der Benutzeroberfläche: Dropdown

Beispiele:

Simpel
Erweitert

<Choice Id="Classification" Label="Klassifizierung">
  <Option Value="public" Label="Öffentlich" />
  <Option Value="confidential" Label="Vertraulich" />
  <Option Value="secret" Label="Geheim" />
</Choice>

<Choice Id="Classification" Label="Klassifizierung" Required="true" SelectedValue="confidential" EmptyOptionLabel="Bitte Klassifizierung wählen...">
  <Option Value="public" Label="Öffentlich" />
  <Option Value="confidential" Label="Vertraulich" />
  <Option Value="secret" Label="Geheim" />
  <Description>Bitte beachten: Geheime Dokumente dürfen niemals per E-Mail versendet werden.</Description>
  <ValidationMessage>Bitte Klassifizierung auswählen.</ValidationMessage>
</Choice>

Attribute für Choice:

Attributname	Beschreibung
`Id` (erforderlich)	Wird zur Identifikation benötigt (Einfügen in der Vorlage, Verwendung in Skripten). Darf keine Leerzeichen enthalten und muss eindeutig sein. Forms fügt automatisch den Präfix `Forms.` hinzu (aus `Classification` wird z. B. `Forms.Classification`).
`Label` (erforderlich)	Beschriftung des Elements in der Eingabeoberfläche
`Required` (optional)	Wenn `true`: Der Benutzer muss eine Option auswählen. Empfohlen: Zusätzlich eine spezifische `ValidationMessage` konfigurieren.
`SelectedValue` (optional)	Vorausgewählte Option: Hier muss der Wert, der bei der gewünschten Option im `Value`-Attribut steht, angegeben werden.
`EmptyOptionLabel` (optional)	Beschriftung der Option, die "nichts ausgewählt" symbolisiert

Inhalte für Choice:

Elementname	Beschreibung
`Option` (erforderlich, mehrere möglich)	Mögliche Auswahl. Es muss mindestens eine mögliche Auswahl konfiguriert werden. Attribute: `Value`: Entspricht `Value` von ComboBox-DataNode beim Dokument-Parameter. `Label`: Entspricht `DisplayText` von ComboBox-DataNode beim Dokument-Parameter.
`Description` (optional)	Zusätzliche Informationen für den Benutzer, der das Formular ausfüllt. Wird in der Eingabeoberfläche angezeigt.
`ValidationMessage` (optional)	Text, der dem Benutzer angezeigt wird, wenn diese Auswahl ungültig ausgefüllt wurde.

Glossar, Begriffe

Deutsch	Englisch	Bedeutung
Forms	Forms	Namen der neuen Dokumentfunktion, früher quasi "Dokument-Parameter"
Forms-Dialog	Forms dialog	Bezeichnung für den neuen Dialog, früher quasi "Dokument-Parameter-Dialog"
Formularelement	Form element	Ein Input-Element im Forms-Dialog, z. B. vom Typ "Text" oder "Choice"
Strukturelement	Structural element	Elemente, die im Forms-Dialog angezeigt werden, die aber keinen Input anfordern und daher nicht im Document Part landen
Feld	Field	Alle Formularelemente, welche schlussendlich im Document Part landen
Nur-Text-Inhaltssteuerelement	Plain Text Content Control	Word-Content Control, das nur Text enthalten kann (offizielle Bezeichnung im Word-GUI)
Datumsauswahl-Inhaltssteuerelement	Date Picker Content Control	Word-Content Control, bei dem ein Datum ausgewählt werden kann (offizielle Bezeichnung im Word-GUI)
Kontrollkästchensteuerelement	Check Box Content Control	Word-Content Control mit CheckBox-Symbol, das aktiviert und deaktiviert werden kann (offizielle Bezeichnung im Word-GUI)
Dropdownlisten-Inhaltssteuerelement	Drop-Down List Content Control	Word-Content Control, beidem aus vorgegebenen Optionen ausgewählt werden kann (offizielle Bezeichnung im Word-GUI)
Kombinationsfeld-Inhaltssteuerelement	Combo Box Content Control	Word-Content Control, beidem aus vorgegebenen Optionen ausgewählt und auch irgendein gewünschter Text eingegeben werden kann (offizielle Bezeichnung im Word-GUI)