Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

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
(optional)

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

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

Advanced

<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

Id
(required)

Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix Forms. (e.g. Subject becomes Forms.Subject).

Label
(required)

Label of the element in the input interface.

Value
(optional)

Predefined text that the user can edit

MultiLine
(optional)

If true: possibility in the input interface to insert line breaks

Required
(optional)

If true: user must make an input, the text must not be empty and must not consist only of spaces. Recommended: Additionally configure a specific ValidationMessage.

Contents for Text

Element name

Description

Description
(optional)

Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip).

ValidationMessage
(optional)

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

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

Advanced

<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

Id
(required)

Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix Forms. (e.g. MustBeSigned becomes Forms.MustBeSigned).

Label
(required)

Label of the element in the input interface

Value
(optional)

If true: The YesNo option is enabled at the beginning

RequiredValue
(optional)

If true: The user must enable the YesNo option.
If false: The user must disable the YesNo option.
Recommended: Additionally configure a specific ValidationMessage.

Contents for YesNo

Element name

Description

Description
(optional)

Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip).

ValidationMessage
(optional)

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

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

Advanced (with Value and Required)

<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)

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

Attribute für Date

Attribute name

Description

Id
(required)

Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix Forms. (e.g. CreationDate becomes Forms.CreationDate).

Label
(required)

Labeling of the element in the input interface

Format
(required)

Definition of the date format, e.g. dd.MM.yyyy for "31.12.2020" or d. MMMM yyyy for "December 31, 2020". See List of date formats.
In the base configuration, there are several date formats in the global translations that can be accessed.

Required
(optional)

If true: the user must select a date, the date must not be empty.
Recommended: Additionally configure a specific ValidationMessage.

Value
(optional)

Pre-selected fixed date that the user can edit.
Format: yyy-MM-dd, e. B. 2020-12-31
Cannot be used in combination with RelativeDate.

RelativeDate
(optional)

Pre-selected date that the user can edit and that is relative to the time of document creation.

  • If Today: date of document creation

  • If FirstDayOfMonth: first day of the month of document creation

  • If FirstDayOfYear: first day of the year of document creation

The OffsetMonths and OffsetDays attributes can be used to further customize the relative date.
Examples:

  • Current day: RelativeDateOption="Today"

  • First day of current month: RelativeDateOption="FirstDayOfMonth"

  • Last day of previous month: RelativeDateOption="FirstDayOfMonth" OffsetDays="-1"

  • Last day of current month: RelativeDateOption="FirstDayOfMonth" OffsetMonths="1" OffsetDays="-1"

  • Last day of previous year: RelativeDateOption="FirstDayOfYear" OffsetDays="-1"

  • Last day of current year: RelativeDateOption="FirstDayOfYear" OffsetMonths="12" OffsetDays="-1"

OffsetMonths
(optional)

Number of months added to the relative date (positive and negative numbers allowed). See RelativeDateOption.

OffsetDays
(optional)

Number of days added to the relative date (positive and negative numbers allowed). See RelativeDateOption.

Contents for Date

Element name

Description

Description
(optional)

Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip).

ValidationMessage
(optional)

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

<Choice Id="Classification" Label="Classification">
  <Option Value="public" Label="Public" />
  <Option Value="confidential" Label="Confidential" />
  <Option Value="secret" Label="Secret" />
</Choice>

Advanced

<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

Id
(required)

Required for identification (insertion in template, use in scripts). Must not contain spaces and must be unique. Forms automatically adds the prefix Forms. (e.g. Classification becomes Forms.Classification).

Label
(required)

Label the element in the input interface.

Required
(optional)

If true: the user must select an option.
Recommended: Additionally configure a specific ValidationMessage.

SelectedValue
(optional)

Preselected option: The value that is in the Value attribute for the desired option must be specified here.

EmptyOptionLabel
(optional)

Label of the option symbolizing "nothing selected"

Contents for Choice

Element name

Description

Option
(required,
several possible)

Possible selection. At least one possible selection must be configured.
Attributes:

Description
(optional)

Additional information for the user filling in the form. Displayed in the input interface (possibly as a tooltip).

ValidationMessage
(optional)

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.

  • No labels

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland