This field type only works within iCM and is designed to be used in article extra and subsite configuration forms.
Only articles, media types/groups/items, metadata groups/properties/values, site user groups, and templates are supported at the moment.
Properties
| Label | Description | Type Name |
|---|---|---|
| Asset Type | The type of iCM asset that can be selected. Articles, media types/groups/items, metadata groups/properties/values, site user groups, and templates are currently supported. Select the type from the list provided | ASSETTYPE |
| Sub-type | This option is only supported for a Media (item) asset type. It lets you restrict the selection to particular types of media (eg images). Enter the IDs of the types of media (as seen in the Media Definitions section of iCM) that you'd like users to be able to pick. Leaving this option blank, or entering a non-existent type, allows any type of media to be picked | SUBTYPE |
| Label | The field's label | LABEL |
| Select Label | The select button's label | SELECTLABEL |
| Remove Label | The remove button's label | REMOVELABEL |
| Hint | Additional information displayed alongside the field to assist the user. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Empty Text | The text displayed in the list when no items are selected. The text specified will automatically be wrapped in < > brackets. The default text is "No items" | EMPTYTEXT |
| Minimum | The minimum number of assets that should be selected. The default is 0 | MINREQUIRED |
| Maximum | The maximum number of assets that may be selected. The default is 99 | MAXREQUIRED |
| Width | The display width of the list box. The value matches a CSS class, which actually sets the width | WIDTH |
| Size | The height of the list box in rows. If more items are chosen than the number here, the user will see a scrollbar | SIZE |
| Default | Default value for the field. Set a comma-delimited list of asset IDs to display those assets in the list | DEFAULT |
| Default Function | A JavaScript function that can be used to calculate the default field value. This function is executed server-side when the field HTML is generated and is useful when the DEFAULT property is insufficient | DEFFUNC |
| Validation Function | A JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| Searchable | Whether this field's value should be indexed by the search (the object collection if using the database save action and/or workflow process collection if starting a workflow process). This property is ignored if an External Type is specified for the form. In this case, the ability to search is determined by the searchable property of the type itself | SEARCHABLE |
| Error Message | The validation error message | ERRMSG |
| Error Message Function | A function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field can be used by adding the field's name between # characters. See Error Message Functions for more information. This field has the following error types:
| ERRMSGFUNC |
| Handlers | A JavaScript function that is executed browser-side whenever the page loads or the field value changes. See Common Field Properties for an example | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| Ordered List | Whether to allow the re-ordering of items within the list. Set to true to include controls for moving the selected assets up/down within the list | ORDERED |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
Last modified on 26 February 2024
Share this page
