Toggle menu

Properties

There are two types of property, form and page. These are configuration settings that can be changed in the forms designer and determine the global and page level attributes of a form.

Different property types range from simple strings to complex JSON encoded JavaScript objects. Many of these properties are required by the site templates.

Pre-defined Properties used by iCM

PropertyDescription
BooleanThis allows a true or false value to be selected as the property value
DateThis allows a fixed date to be selected as the property value. A calendar dialogue can be used to select the date
IntegerThis allows an integer to be entered as the property value
StringThis allows a single string to be entered as the property value
String (Multiline)This allows a multi-line string to be entered as the property value. A multi-line dialogue can be used to enter the value
Regular ExpressionThis allows a JavaScript regular expression to be entered as the property value. A dialogue is available to assist with the entry of the regular expression. This can also be used for testing the expression
ListThis allows the selection of a single value for the property from a list. The value displayed in the list can be different from value set for the property
Combo BoxThis allows the selection of a single value for the property from a list or the entering of a different value
DataThis allows the property value to contain a list of values. Each value can consist of the actual value and a display value. A dialogue is used in the form designer to allow these values to be entered directly or read from a database
Grouped DataThis allows the property value to contain a list of values. Each value can consist of the actual value and a display value. An additional value can be specified that allows the list content to be grouped. A dialogue is used in the form designer to allow these values to be entered directly or read from a database

Copy a Property

The copy a property option is used to create a duplicate property. Right-click on the property you would like to copy and click "Copy this property".

Create or Edit a Property

To create a new property right-click on "Form Properties" or "Page Properties" and choose "Create a property". To edit an existing property, double-click on it.

For each property you can define:

PropertyDescription
NameA unique identifier for the property
TypeOne of the pre-defined types described above
OptionsThe list items a user can select in this property (if applicable)
LabelThe label that will be displayed in the forms designer
DescriptionA short description of the property
Default for existing fieldsAn optional default value for the property where this field has already been added to a form. This default value will be preserved even if the form is imported, exported and republished
Default for new fieldsAn optional default value that will be used when the field is added to a form
ValidationNot currently used
Display OrderThe property's ordering in the settings panel in the forms designer
Allow EditTrue if the property can be edited in the designer, false if not
Help TextThe help text visible in the forms designer

Two Default Values?

There may be times when a new version of a field is released as part of an iCM patch or fix and the previous behaviour needs to be retained in forms that are already in use.

Field properties can supply two default values. In the majority of cases the two default values will be the same. The value that gets used depends on when the field is added to a form.

For example, an existing form is using a field with a property that has a default value of SERVER. A new version of the field is released in an update. The default for existing fields is kept as SERVER, the default for new fields is now CLIENT.

The existing forms can be republished, exported, imported, republished somewhere else, and the default value for existing fields in our example will stay as SERVER. If another copy of the field is added to any form (either brand new forms, or existing forms) the default value will be CLIENT. The decision about which default value to use is made as the new field is added to the form. This does mean that one form may have "old" and "new" fields with different defaults.

Delete a Property

To delete a property, right-click on it and select "Delete this property". Be very careful when deleting any items in a form family as it could cause some forms to stop working when they are next published.

Last modified on 26 June 2020

Share this page

Facebook icon Twitter icon email icon

Print

print icon