Check Box

The CheckBox component is a wrapper of a check box element.

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: CheckBox1

checkBoxName

• Description: (REQUIRED) Enter unique name of CheckBox form tag. Must not match the 'name' property.
• Type: String
• Default Value: CheckBoxName1

formName

• Description: Enter the name of the form in which the checkbox resides.
• Type: String

checked

• Description: Select whether the checkbox is checked.
• Value Set: true | false
• Type: Boolean
• Default Value: false

checkedVal

• Description: Enter the value used for checked boxes (does not apply to editable boxes).
• Type: String

uncheckedVal

• Description: Enter the value used for unchecked boxes (does not apply to editable boxes).
• Type: String

state

• Description: Select the checkbox 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

Render

• Name: render()
• Description: Renders control.

Events

On Click

• Name: onClick()
• Description: Event fires on click of the CheckBox.

On Focus

• Name: onFocus()
• Description: Event fires on focus of CheckBox.

On Blur

• Name: onBlur()
• Description: Event fires on blur of CheckBox.

On Render

• Name: onRender()
• Description: Event fires on render of CheckBox.

Other Information

Environment: Client