| Table of Contents |
|---|
NOTE
Forms
...
can be used in the "classic" template types as well as in the newer template types, whereas there are more features.
Structure
| Code Block | ||
|---|---|---|
| ||
<FormsConfiguration>
<Elements>
<!-- |
...
Insert form |
...
elements |
...
and |
...
groups |
...
here --> </Elements> </FormsConfiguration> |
...
Structural elements
Gruppen
...
Groups
Form elements can be grouped with <Group>...</Group>
...
for visual display.
| Code Block | ||
|---|---|---|
| ||
<FormsConfiguration>
<Elements>
<!-- [ |
...
Form elements] --> <Group Title=" |
...
Phone numbers"> <!-- [ |
...
Form elements] --> </Group> <!-- [ |
...
Form elements] --> </Elements> </FormsConfiguration> |
...
Groups must not contain other groups (no nesting).
...
Attributes for Group
...
Attributname |
|---|
...
Description |
|---|
|
...
Title that will be displayed on the input interface. |
Info
Wird dem Benutzer auf der Eingabeoberfläche angezeigt. Der anzuzeigende Text wird als Inhalt des Info-Elements angegeben.
...
Displayed to the user on the input interface. The text to be displayed is specified as the content of the info element.
Example:
| Code Block | ||
|---|---|---|
|
...
<Info>Important: |
...
Each log must also be sent in the Teams channel `Log feed`.</Info> |
...
Form elements
Text
...
Inserted into Word as a Plain Text Content Control
...
Bietet dem Benutzer die Möglichkeit, in der Eingabeoberfläche einen Text einzugeben.
...
Typische Ausprägung in der Benutzeroberfläche: Textfeld
...
.
Provides the user with the ability to enter text in the input interface.
Typical expression in the user interface: text field.
Examples
Simple
| Code Block | ||
|---|---|---|
| ||
<Text Id="Subject" Label=" |
...
Subject" /> |
...
Advanced
| Code Block | ||
|---|---|---|
| ||
<Text Id="Subject" Label=" |
...
Subject" Value=" |
...
Protocol |
...
for" MultiLine="true" Required="true"> <Description>Please |
...
enter an |
...
appropriate |
...
subject |
...
that |
...
describes |
...
the |
...
request |
...
briefly, |
...
concisely |
...
and |
...
precisely.</Description> |
...
<ValidationMessage>Please |
...
enter |
...
a |
...
subject.</ValidationMessage> </Text> |
...
Attributes for Text
...
...
Attribute name |
|---|
...
Description |
|---|
|
...
required) |
...
Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
|
...
required) |
...
Label of the element in the input interface. |
|
...
Predefined text that the user can edit |
|
...
If |
...
possibility in the input interface to insert line breaks |
|
...
If |
...
Inhalte für Text:
...
Elementname
...
user must make an input, the text must not be empty and must not consist only of spaces. Recommended: Additionally configure a specific |
Contents for Text
Element name | Description |
|---|---|
|
...
Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip). | |
| Text |
...
that will be displayed to the user if this text field was filled in invalidly. |
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
...
Inserted in Word as a check box content control.
Provides the user with the ability to check ("Yes") or uncheck ("No") an option in the input interface.
Typical expression in the user interface: Checkbox
Examples
Simple
| Code Block | ||
|---|---|---|
| ||
<YesNo Id="MustBeSigned" Label="Muss unterzeichnet werden" /> |
...
Advanced
| Code Block | ||
|---|---|---|
| ||
<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> |
...
Attributes for YesNo
...
...
Attribute name |
|---|
...
Description |
|---|
|
...
required) |
...
Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
|
...
required) |
...
Label of the element in the input interface |
|
...
If |
...
The YesNo option is enabled at the beginning |
|
...
If |
...
Inhalte für YesNo:
...
Elementname
...
The user must enable the YesNo option. |
Contents for YesNo
Element name | Description |
|---|---|
|
...
Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip). | |
| Text |
...
that will be displayed to the user if this text field was filled in invalidly. |
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
...
Inserted into Word as a date picker content control.
Provides the user with the ability to select a date in the input interface
Typical expression in the user interface: Datepicker
Examples
Simple
| Code Block | ||
|---|---|---|
| ||
<Date Id="CreationDate" Label=" |
...
Creation date" Format="dd.MM.yyyy" /> |
...
Advanced (
...
with Value
...
and Required)
...
| Code Block | ||
|---|---|---|
| ||
<Date Id="CreationDate" Label=" |
...
Creation date" Format="dd.MM.yyyy" Value="2020-12-31" Required="true"> |
...
<Description>Optimally, |
...
the |
...
date |
...
of |
...
mailing |
...
should |
...
be |
...
selected |
...
here.</Description> <ValidationMessage>Please |
...
select |
...
a |
...
creation |
...
date.</ValidationMessage> </Date> |
...
Advanced (
...
with RelativeDate)
...
| Code Block | ||
|---|---|---|
|
...
Date Id="CreationDate" Label=" |
...
Creation date" Format="dd.MM.yyyy" RelativeDate="FirstDayOfMonth" OffsetMonths="2" OffsetDays="-1" /> |
Attribute für Date
...
...
Attribute name |
|---|
...
Description |
|---|
|
...
required) |
...
Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
|
...
required) |
...
Labeling of the element in the input interface |
|
...
required) | Definition |
...
of the date format, e.g. |
...
for "31.12.2020" |
...
or |
...
for "December 31 |
...
, 2020". |
...
See List of date formats. |
|
...
If |
...
the user must select a date, the date must not be empty. |
|
...
Pre-selected fixed date that the user can edit. |
...
|
...
e. B. |
...
Cannot be used in combination with |
|
Vorausgewähltes Datum, das der Benutzer bearbeiten kann und das relativ zum Zeitpunkt der Dokumenterstellung ist.
Wenn
Today: Datum der DokumenterstellungWenn
FirstDayOfMonth: Erster Tag des Monats der DokumenterstellungWenn
FirstDayOfYear: Erster Tag des Jahres der Dokumenterstellung
Die Attribute OffsetMonths und OffsetDays können verwendet werden, um das relative Datum weiter anzupassen.
Beispiele:
Pre-selected date that the user can edit and that is relative to the time of document creation.
The
|
...
|
...
|
...
|
...
|
...
|
|
...
Inhalte für Date:
...
Elementname
...
Number of months added to the relative date (positive and negative numbers allowed). See |
|
...
Anzahl Tage, die zum relativen Datum dazuaddiert werden (positive und negative Zahlen erlaubt). Siehe RelativeDateOption.
Number of days added to the relative date (positive and negative numbers allowed). See |
Contents for Date
Element name | Description |
|---|---|
|
...
Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip). | |
| Text |
...
that will be displayed to the user if this text field was filled in invalidly. |
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
...
Inserted into Word as a combo box content control.
Offers the user the possibility to choose between different options in the input interface.
Typical appearance in the user interface: Dropdown
Examples
Simple
| Code Block | ||
|---|---|---|
| ||
<Choice Id="Classification" Label=" |
...
Classification"> <Option Value="public" Label=" |
...
Public" /> <Option Value="confidential" Label=" |
...
Confidential" /> <Option Value="secret" Label=" |
...
Secret" /> </Choice> |
...
Advanced
| Code Block | ||
|---|---|---|
| ||
<Choice Id="Classification" Label="Klassifizierung" Required="true" SelectedValue="confidential" EmptyOptionLabel=" |
...
Please |
...
select |
...
classification..."> <Option Value="public" Label=" |
...
Public" /> <Option Value="confidential" Label=" |
...
Confidential" /> <Option Value="secret" Label=" |
...
Secret" /> |
...
<Description>Please |
...
note: |
...
Secret |
...
documents |
...
must |
...
never |
...
be |
...
sent |
...
by |
...
e-mail.</Description> |
...
<ValidationMessage>Please |
...
select |
...
classification.</ValidationMessage> </Choice> |
...
Attributes for Choice
...
...
Attribute name |
|---|
...
Description |
|---|
|
...
required) |
...
Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
|
...
required) |
...
Label the element in the input interface. |
|
...
If |
...
the user must select an option. |
...
Recommended: Additionally configure a specific |
|
...
Inhalte für Choice:
...
Elementname
...
Preselected option: The value that is in the |
|
...
Beschriftung der Option, die "nichts ausgewählt" symbolisiert
Label of the option symbolizing "nothing selected" |
Contents for Choice
Element name | Description |
|---|---|
|
...
required, |
...
several possible) |
...
Possible selection. At least one possible selection must be configured.
|
...
|
...
...
|
...
|
...
...
|
...
Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip). | |
| Text |
...
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)
...
that will be displayed to the user if this text field was filled in invalidly. |
Glossary, Terms
Name | Meaning |
|---|---|
Forms | Name of the new document function, formerly quasi "Document Parameter". |
Forms dialog | Name for the new dialog, formerly quasi "Document Parameter dialog" |
Form element | An input element in the Forms dialog, e.g. of type "Text" or "Choice |
Structural element | Elements that are displayed in the Forms dialog but do not request input and therefore do not end up in the Document Part |
Field | All form elements, which finally end up in the Document Part |
Plain Text Content Control | Word content control that can only contain text |
Date Picker Content Control | Word content control where a date can be selected |
Check Box Content Control | Word content control with CheckBox icon that can be enabled and disabled |
Drop-Down List Content Control | Word |
...
content control, where you can choose from predefined options | |
Combo Box Content Control | Word |
...
content control, where you can choose from predefined options and enter any text you want. |