Select Box
The SelectBox component is a wrapper of a select element. It can
be rendered as a drop-down list or a scrolling list. Because events
fire on selection, elements such as SelectNav, which takes users to
a different page after selecting an item, can easily be configured
with this control.
Properties
name
- Description: (REQUIRED) Enter unique name of the control. Must exactly match the name of the corresponding JavaScript object on the page.
- Type: String
- Default Value: SelectBox1
selectBoxName
- Description: (REQUIRED) Enter unique name of SelectBox form tag. Must not match the 'name' property.
- Type: String
- Default Value: selectBoxName1
formName
- Description: Enter the name of the form in which the SelectBox resides.
- Type: String
size
- Description: Enter the SelectBox size in characters.
- Type: Number
- Default Value: 20
multiple
- Description: Select whether this control allows multiple selections.
- Value Set: true | false
- Type: Boolean
- Default Value: true
labelsListStr
- Description: (REQUIRED) Enter the semicolon delimited list of labels to be displayed by the control.
- Type: String
valuesListStr
- Description: (REQUIRED) Enter the semicolon delimited list of values to be associated for each label.
- Type: String
selectedStr
- Description: (REQUIRED) Enter the selected value(s). More than one can be entered for multi-select lists.
- Type: String
- Method: setSelected()
- Method: getSelected()
validate
- Description: Select whether validation should be performed.
- Value Set: true | false
- Type: Boolean
- Default Value: true
isRequired
- Description: Select whether this value is required.
- Value Set: true | false
- Type: Boolean
- Default Value: false
state
- Description: Select the SelectBox state.
- Value Set: editable | read-only | hidden
- Default Value: editable
- Type: String
testMode
- Description: Select the test mode.
- Value Set: off | alerts | text
- Type: String
- Default Value: off
- Is Expert: Yes
Methods
Set Selected
- Name: setSelected()
- Description: Sets selected items String.
Get Selected
- Name: getSelected()
- Description: Gets String of selected items.
Validate Value
- Name: validateValue()
- Description: Validates SelectBox value.
Render
- Name: render()
- Description: Renders control.
Events
On Blur
- Name: onBlur()
- Description: Event fires on blur (or loss of focus) of value in SelectBox.
On Change
- Name: onChange()
- Description: Event fires on change of value in SelectBox.
On Focus
- Name: onFocus()
- Description: Event fires on focus of SelectBox.
On Click
- Name: onClick()
- Description: Event fires on click of SelectBox.
On Validate
- Name: onValidate()
- Description: Event fires on attempt to validate SelectBox value.
On Invalid
- Name: onInvalid()
- Description: Event fires on faliure to validate SelectBox value.
On Valid
- Name: onValid()
- Description: Event fires on successful validation of SelectBox value.
On Render
- Name: onRender()
- Description: Event fires on render of SelectBox.
Other Information
Environment: Client