JavaScript/jQuery CheckBox API
The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific property has been chosen.
See Also
jQuery
Angular
Vue
React
Options
An object defining configuration properties for the CheckBox UI component.
Name | Description |
---|---|
accessKey | Specifies the shortcut key that sets focus on the UI component. |
activeStateEnabled | Specifies whether the UI component changes its visual state as a result of user interaction. |
disabled | Specifies whether the UI component responds to user interaction. |
elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
enableThreeStateBehavior | Specifies whether users can set the CheckBox state to indeterminate. |
focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
height | Specifies the UI component's height. |
hint | Specifies text for a hint that appears when a user pauses on the UI component. |
hoverStateEnabled | Specifies whether the UI component changes its state when a user pauses on it. |
iconSize | Specifies the check box icon's width and height. |
isDirty | Specifies whether the component's current value differs from the initial value. |
isValid | Specifies or indicates whether the editor's value is valid. |
name | The value to be assigned to the |
onContentReady | A function that is executed when the UI component is rendered and each time the component is repainted. |
onDisposing | A function that is executed before the UI component is disposed of. |
onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
onOptionChanged | A function that is executed after a UI component property is changed. |
onValueChanged | A function that is executed after the UI component's value is changed. |
readOnly | Specifies whether the editor is read-only. |
rtlEnabled | Switches the UI component to a right-to-left representation. |
tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
text | Specifies the text displayed by the check box. |
validationError | Information on the broken validation rule. Contains the first item from the validationErrors array. |
validationErrors | An array of the validation rules that failed. |
validationMessageMode | Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
validationMessagePosition | Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. |
validationStatus | Indicates or specifies the current validation status. |
value | Specifies the UI component state. |
visible | Specifies whether the UI component is visible. |
width | Specifies the UI component's width. |
See Also
Methods
Name | Description |
---|---|
beginUpdate() | Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
blur() | Removes focus from the check box. |
clear() | Resets the value property to the default value. |
defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
dispose() | Disposes of all the resources allocated to the CheckBox instance. |
element() | Gets the root UI component element. |
endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
focus() | Sets focus on the UI component. |
getInstance(element) | Gets the instance of a UI component found using its DOM node. |
instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
off(eventName) | Detaches all event handlers from a single event. |
off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
on(eventName, eventHandler) | Subscribes to an event. |
on(events) | Subscribes to events. |
option() | Gets all UI component properties. |
option(optionName) | Gets the value of a single property. |
option(optionName, optionValue) | Updates the value of a single property. |
option(options) | Updates the values of several properties. |
registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
repaint() | Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
reset(value) | Resets the value property to the value passed as an argument. |
resetOption(optionName) | Resets a property to its default value. |
Events
This section describes events fired by this UI component.
Name | Description |
---|---|
contentReady | Raised when the UI component is rendered and each time the component is repainted. |
disposing | Raised before the UI component is disposed of. |
initialized | Raised only once, after the UI component is initialized. |
optionChanged | Raised after a UI component property is changed. |
valueChanged | Raised after the UI component's value is changed. |
See Also
Types
Name | Description |
---|---|
ContentReadyEvent | The type of the contentReady event handler's argument. |
DisposingEvent | The type of the disposing event handler's argument. |
InitializedEvent | The type of the initialized event handler's argument. |
OptionChangedEvent | The type of the optionChanged event handler's argument. |
ValueChangedEvent | The type of the valueChanged event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.