Forms classic
- Dinah Bolli (Unlicensed)
- 1 Structure
- 2 Structural elements
- 3 Form elements
- 3.1 Text
- 3.1.1 Examples
- 3.1.2 Attributes for Text
- 3.1.3 Contents for Text
- 3.2 YesNo
- 3.2.1 Examples
- 3.2.2 Attributes for YesNo
- 3.2.3 Contents for YesNo
- 3.3 Date
- 3.3.1 Examples
- 3.3.2 Attribute für Date
- 3.3.3 Contents for Date
- 3.4 Choice
- 3.4.1 Examples
- 3.4.2 Attributes for Choice
- 3.4.3 Contents for Choice
- 3.1 Text
- 4 Glossary, Terms
NOTE
Forms can be used in the "classic" template types as well as in the newer template types, whereas there are more features.
Structure
<FormsConfiguration>
<Elements>
<!-- Insert form elements and groups here -->
</Elements>
</FormsConfiguration>Structural elements
Groups
Form elements can be grouped with <Group>...</Group> for visual display.
<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
Displayed to the user on the input interface. The text to be displayed is specified as the content of the info element.
Example:
<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.
Provides the user with the ability to enter text in the input interface.
Typical expression in the user interface: text field.
Examples
Simple
Advanced
Attributes for Text
Attribute name | Description |
|---|---|
| Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
| Label of the element in the input interface. |
| Predefined text that the user can edit |
| If |
| If |
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
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
Advanced
Attributes for YesNo
Attribute name | Description |
|---|---|
| Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
| Label of the element in the input interface |
| If |
| If |
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
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
Advanced (with Value and Required)
Advanced (with RelativeDate)
Attribute für Date
Attribute name | Description |
|---|---|
| Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
| Labeling of the element in the input interface |
| Definition of the date format, e.g. |
| If |
| Pre-selected fixed date that the user can edit. |
| Pre-selected date that the user can edit and that is relative to the time of document creation.
The
|
| Number of months added to the relative date (positive and negative numbers allowed). See |
| 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
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
Advanced
Attributes for Choice
Attribute name | Description |
|---|---|
| Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix |
| Label the element in the input interface. |
| If |
| Preselected option: The value that is in the |
| Label of the option symbolizing "nothing selected" |
Contents for Choice
Element name | Description |
|---|---|
| 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 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. |
PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland