CheckBox

A check box widget.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The main purpose of the dxCheckBox widget is to allow a user to check or uncheck an option, and perform a specified action when widget value changes.

You can create a widget using one of the following approaches.

jQuery
Use the dxCheckBox jQuery plug-in.

HTML

<div id="checkBox"></div>

JavaScript

$("#checkBox").dxCheckBox({
    text: 'Option enabled',
    value: true
});

Knockout
Add a div element and apply the dxCheckBox binding to this element.

HTML

<div data-bind="dxCheckBox: {
    text: 'Option enabled',
    value: true
}"></div>

Angular
Add a div element and apply the dx-check-box directive to this element.
HTML
```
<div dx-check-box="{
    text: 'Option enabled',
    value: true
}"></div>
```

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

Configuration

An object defining configuration options for the dxCheckBox widget.

Name	Description
accessKey	Specifies a shortcut key that sets focus on the widget element.
activeStateEnabled	A Boolean value specifying whether or not the widget changes its state when interacting with a user.
disabled	A Boolean value specifying whether or not the widget can respond to user interaction.
focusStateEnabled	Specifies whether or not the widget can be focused.
height	Specifies the height of the widget container.
hint	Specifies the text of the hint displayed for the widget.
hoverStateEnabled	A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.
isValid	Specifies whether the editor's value is valid.
onDisposing	A handler for the disposing event.
onInitialized	A handler for the initialized event.
onOptionChanged	A handler for the optionChanged event.
onValueChanged	A handler for the valueChanged event.
readOnly	A Boolean value specifying whether or not the widget is read-only.
rtlEnabled	Specifies whether or not the current component supports a right-to-left representation.
tabIndex	Specifies the widget tab index.
text	Specifies the text displayed by the check box.
validationError	Holds the object that defines the error that occurred during validation.
validationMessageMode	Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
value	Specifies the widget state.
visible	A Boolean value specifying whether or not the widget is visible.
width	Specifies the width of the widget container.

Methods

This section describes the members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the component from refreshing until the endUpdate method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
element()	Returns the root HTML element of the widget.
endUpdate()	Enables the component to refresh after the beginUpdate method call.
focus()	Sets focus on the widget.
instance()	Returns an instance of this component class.
off(eventName)	Detaches all event handlers from the specified event.
off(eventName, eventHandler)	Detaches a particular event handler from the specified event.
on(eventName, eventHandler)	Subscribes to a specified event.
on(events)	Subscribes to the specified events.
option()	Returns the configuration options of this component.
option(optionName)	Gets the value of the specified configuration option of this component.
option(optionName, optionValue)	Sets a value to the specified configuration option of this component.
option(options)	Sets one or more options of this component.
registerKeyHandler(key, handler)	Registers a handler when a specified key is pressed.
repaint()	Redraws the widget.
reset()	Resets the editor's value to undefined.

Events

This section describes events exposed by this widget.

Name	Description
disposing	Fires when the widget is being removed.
initialized	Fires when the widget is initialized.
optionChanged	Fires after an option of the component is changed.
valueChanged	Fires when the editor value changes.

CheckBox

See Also

Configuration

Methods

Events

See Also