Field types are defined in the form family using both skeletons and properties to determine how the form will behave and the type of information that it will store.
The various styles of field types include visual elements, single or multiple value input fields, containers to hold other fields and control buttons such as to submit a form. Each field type has the ability to contain complex validation.
In most cases it makes sense to create a new field type by copying an existing one that is most like the desired result.
If creating a new field type from scratch the best approach is to build it up bit by bit. Usually this means creating the HTMLSkel skeleton first without using any field type properties. Once this HTML (and JavaScript if required) is complete then properties should be gradually added to allow the desired functionality. The next stage is to then consider if any object type definition is required. If so the ObjTypeDefSkel skeleton should be created next. Next validation needs to be considered. Normally it is easiest to concentrate on the client side validation first by creating the ValidationSkel skeleton. If the values collection by fields of this type need to generate text in the read only form rendering used in Emails then a ROHTMLSkel should be created.
Copy a Field Type
To copy a field type, right-click on it and select "Copy this field type". While the original field types cannot be edited directly, you are able to edit your copy.
Create and Edit a Field Type
The original field types cannot be edited, you'll need to make a copy first. To create a new field type, right-click on the Field Types folder and select "Create a field type".
There's a more detailed look at the skeletons that make up a field type in the An Introduction to Form Families and Skeletons reference article.
Each field type has the following options.
| Name | Description |
|---|---|
| Name | A unique identifier for the field type |
| Label | The label displayed for the field type in the forms designer |
| Description | A short description of the field type |
| Category | Determines which section of the designer toolbox the field will appear in |
| Icon | The name of a 16 x 16 pixel gif image to be used to represent the field type. This must be stored in the cstreeicons/fieldtypes folder. The file button.gif in his folder provides a generic default |
| Valid Containers | The container field types into which this field type can be placed in the forms designer. The container called "top" represents a field that can be dragged onto any empty form |
| Help Text | The help text available to users in the forms designer |
| Parent Family | Select the family your new field type will be added to |
| Container | sets whether or not this field type can be used as a container for other fields |
| Hidden | This option is not currently used |
| Composite | True if this field type will submit multiple values |
| Stores Data | True if the field will store data as an iCM object |
| Disabled | True to disable the field so it doesn't appear in the designer |
Delete a Field Type
To delete a field type, right-click on it and select "Delete this field type". 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.
Importing an Exporting Field Types
To export a field type, right-click on it and select "Export this field type". The exported xml file can be imported into another iCM by right-clicking on the root FAMILIES folder and selecting "Import a form family or field type".
Forms Using a Field Type
The "Show content using this field type" option in the action panel of the field type editor generates a list of all of the forms using this field.
Share this page
