Skip to main content
Version: 9.4

SelectBox

This type of form control is similar to the HTML select box and the ComboBox control.

<select id="floor" 
data-win-control="HFWinJSCtrl.SelectBox"
data-win-options="{
label: 'Floor',
defaultValue: '1',
required: true
}">
<option> </option>
<option value="1">1st floor</option>
<option value="2">2nd floor</option>
</select>
PropertyTypeHow to useDescription
defaultValueStringdefaultValue: '1'Set the initial status of the SelectBox to a "selected" option. A custom code function can be used to set defaultValue.
deletableBooleandeletable: trueSet "true" whenever the values of the SelectBox should be deletable. The default value is false.
disabledBooleandisabled: trueSet "true" whenever the SelectBox should be disabled. The default value is false.
doNotCopyBooleandoNotCopy: trueSet "true" whenever the field should get deleted if form is copied.
labelStringlabel: 'Floor'Define a label for your control element.
listBooleanlist: trueSet this property to "true" if data connected with this control should be a sorting/filtering/grouping option on the listpage, is used in template objects (eg. the listTemplate) or it should show up in admin ui listings.
listOptionsObjectlistOptions: {...}Set additional options for controls with list equals true. E.g. set custom label for filter/sort/group dialogs or hide them complettely.
mappingBooleanmapping: trueSet "true" whenever the form element should be visible / editable in the corresponding SharePoint list.
persistentStringpersistent: 'user'The value "user" sets the initial selected value of the select box to the value of the previous form item of the current user and overwrites any defaultValue.
requiredBooleanrequired: trueSet "true" if the control has to be filled in.
tooltipStringtooltip: 'Please indicate at least one cause of damage.'Write a comment to provide further information about the field. A question mark will then be shown within the label and with a click/tap on it, the information will occur.
visitingBooleanvisiting: trueSet "true" whenever the form element should be marked as "visited" when the user has clicked or tapped at the form field.
onChangedFunction(value: string)onChanged: HFFormdefinition.Namespace.MethodCall a pre-defined JS-method to do something when the status of the control changes (optional)

listOptions Object

PropertyTypeHow to useDescription
dialogTextStringdialogText: 'Display Text'Set custom label for filter/sort/group dialogs.
dialogHideBooleandialogHide: trueHide field from filter/sort/group dialogs.

Stored data

For each SelectBox there are two value pairs stored:

{
"id": "floor",
"value": "1"
}
{
"id": "floor_HFSelectText",
"value": "1st floor"
}