Skip to main content
Version: v11.5.3

Checkbox


A checkbox is a specific type of two-states button that can be either checked or unchecked. Checkboxes let a user select an option. Examples: "I agree to terms and conditions" etc. checked and unchecked options.

Properties

PropertyDescription
CaptionThe caption is the text that the end user sees on the button. This property can be bound to any variable or another widget.
NameThe name is a unique identifier for the button. Special characters and spaces are not allowed in widget name.
Accessibility
HintAny text you enter for this property will be shown as a tooltip when the mouse hovers over this widget for _1.5 seconds. _It can be bound to a variable or another widget.
Tab IndexThe tab index attribute specifies the tab order of an element. You can use this property to change the default tabbing order for widget access using the tab key. The value can range from 0 to 32767. The default is 0 and -1 makes the element non-focusable. NOTE: In Safari browsers, by default, Tab highlights only text fields. To enable Tab functionality, in Safari Browser from Preferences -> Advanced -> Accessibility set the option "Press Tab to highlight each item on a webpage".
Shortcut KeyAlphabet to act as a Shortcut key. The shortcut key property specifies a key to click the button. The way to activate the shortcut key varies from browser to browser (see below for details).
Layout
WidthThe width of your widget can be specified in em, pt, px or % (_i.e _50px, 75%).
HeightThe height of your widget can be specified in em, pt, px or % (_i.e _50px, 75%).
Default Value
ValueThis is the default value to display value for an editor widget. Note that the display value is just what the user sees initially, and is not always the dataValue returned by the widget.
Checked ValueThis property defines the value of the widget when the element is in the checked state. The default value is boolean value true. If specified, the value will be of string type.
Unchecked ValueThis property defines the value of the widget when the element is in the unchecked state.
Validation
RequiredA required editor in wm.LiveForm may refuse to save without a required field.
Behavior
ShowShowing determines whether or not a component is visible. It is a bindable property.
Load on Demand (visible only when show property is bound to a variable)When this property is set and show property is bound, the initialization of the widget will be deferred till the widget becomes visible. This behavior improves the load time. Use this feature with caution, as it has a downside (as we will not be able to interact with the widget through script until the widget is initialized). When show property is not bound the widget will be initialized immediately.
DisabledIf the disabled property is true (checked) the widget becomes display-only and user input will not be accepted. It can also set programmatically by binding it to a boolean type variable.

Shortcut key: The shortcut key property specifies a shortcut key to check the checkbox. The way of accessing the shortcut key is varying in different browsers:

BrowserShortcut key Trigger
Internet Explorer[Alt] + shortcut key
Chrome[Alt] + shortcut key (Windows/Linux)
[Control][Alt] + shortcut key (MAC)
Firefox[Alt][Shift] + shortcut key (Windows/Linux)
[Control][Alt] + shortcut key (MAC)

Events

EventDescription
ChangeThis event handler is called each time your element's value changes.
On focusThis event handler is called each time your element is focused.
On blurThis event handler is called each time your focus leaves your element.
Mouse Events
On clickIt is an HTML button. It is used to generate a click event. For example, save button.
On mouse enterThis event handler is called whenever the mouse enters the widget.
On mouse leaveThis event handler is called whenever the mouse leaves the widget.
Touch Events
On tapThis event handler is called whenever the widget is tapped.