Frequent properties

<< Display table of contents >>

Navigation:  Start > Customize templates > Create templates > All template types > Inputs > Basic structure of an input method >

Frequent properties

"Type":

Specifies the type of the input field.

Optional:

no

Characteristics:

This entry must be the first within the definition.

Possible values:

Depending on the template type. An overview of the available types can be found here.

Default value:

 

Example:

"Type": TextArea

 

"Label":

The label of the input field to be displayed.

Optional:

yes

Characteristics:

multilanguage is possible

Possible values:

any text

Default value:

 

Example:

"Label": "Comment"

 

"DefaultValue":

A value already pre-filled when the form is loaded.

Optional:

yes

Characteristics:

depends on Type, see TextArea, MultiValueText, DropDownList

Possible values:

any text

Default value:

 

Example:

"DefaultValue": "This is a pre-filled value."

 

"IsEnabled":

Indicates whether the field is editable.

Optional:

yes

Characteristics:

Fields that can not be edited must not be required fields.

Possible values:

true or false

Default value:

true

Example:

"IsEnabled":false

 

"IsRequired":

Indicates whether the field is a mandatory field.

Optional:

yes

Characteristics:

Required fields must not be disabled (IsEnabled).

Possible values:

true or false

Default value:

false

Example:

"IsRequired":true

 

"Description":

Description of the field for display in the tooltip.

Optional:

yes

Characteristics:

multilanguage is possible

Possible values:

any text

Default value:

 

Example:

"Description": "Automatically created, non-modifiable comment."

 

"Items":

An items list for a drop down menu.

Optional:

no

Characteristics:

used only in DropDownList

Possible values:

listing

Default value:

 

Example:

"Items": [

  { "Value": "Berlin", "DisplayValue": "Berlin - Germany" },

  { "Value": "Paris", "DisplayValue": "Paris - France" }

]

 

"DisplayValue":

Value displayed in conjunction with Value.

Optional:

yes

Characteristics:

for DropDownList and FixedValue, multilanguage is possible

Possible values:

any text

Default value:

 

Example:

"Value": "Berlin", "DisplayValue": "Berlin - Germany"

 

"Value":

Actual value, in conjunction with DisplayValue.

Optional:

yes

Characteristics:

for DropDownList and FixedValue

Possible values:

any text

Default value:

 

Example:

"Value": "Berlin", "DisplayValue": "Berlin - Germany"

 

"Constraints": see constraints