CheckBox
The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific option has been chosen.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the CheckBox widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
$(function () {
$("#checkBox").dxCheckBox({
text: "Toggle me",
value: undefined,
onValueChanged: function (e) {
alert(e.value);
}
});
});<div id="checkBox"></div>
Angular
<dx-check-box
text="Toggle me"
[value]="undefined"
(onValueChanged)="checkBoxToggled($event)">
</dx-check-box>
import { DxCheckBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
checkBoxToggled(e) {
alert(e.value);
};
}
@NgModule({
imports: [
// ...
DxCheckBoxModule
],
// ...
})AngularJS
<div ng-controller="DemoController">
<div dx-check-box="{
text: 'Toggle me',
value: undefined,
onValueChanged: checkBoxToggled
}"></div>
</div>angular.module("DemoApp", ["dx"])
.controller("DemoController", function ($scope) {
$scope.checkBoxToggled = function (e) {
alert(e.value);
};
});Knockout
<div data-bind="dxCheckBox: {
text: 'Toggle me',
value: undefined,
onValueChanged: function (e) {
alert(e.value);
}
}"></div>ASP.NET MVC Controls
@(Html.DevExtreme().CheckBox()
.ID("checkBox")
.Text("Toggle me")
.OnValueChanged(@<text>
function (e) {
alert(e.value);
}
</text>)
)@(Html.DevExtreme().CheckBox() _
.ID("checkBox") _
.Text("Toggle me") _
.OnValueChanged("checkBox_valueChanged")
)
<script>
function checkBox_valueChanged(e) {
alert(e.value);
}
</script>See Also
Configuration
An object defining configuration options for the CheckBox widget.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled | Specifies whether or not the widget changes its state when interacting with a user. |
| disabled | Specifies whether the widget responds to user interaction. |
| elementAttr | Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled | Specifies whether the widget can be focused using keyboard navigation. |
| height | Specifies the widget's height. |
| hint | Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled | Specifies whether the widget changes its state when a user pauses on it. |
| isValid | Specifies whether the editor's value is valid. |
| name | The value to be assigned to the |
| onContentReady | A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing | A function that is executed before the widget is disposed of. |
| onInitialized | A function that is executed only once, after the widget is initialized. |
| onOptionChanged | A function that is executed after a widget option is changed. |
| onValueChanged | A function that is executed after the widget's value is changed. |
| readOnly | A Boolean value specifying whether or not the widget is read-only. |
| rtlEnabled | Switches the widget 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 | Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option. |
| 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 | Specifies whether the widget is visible. |
| width | Specifies the widget's width. |
Methods
This section describes the methods that control the widget.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration options for this component. |
| dispose() | Disposes of all the resources allocated to the CheckBox instance. |
| element() | Gets the root widget element. |
| endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
| focus() | Sets focus on the widget. |
| getInstance(element) | Gets the instance of a widget found using its DOM node. |
| instance() | Gets the widget's instance. Use it to access other methods of the widget. |
| 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 widget options. |
| option(optionName) | Gets the value of a single option. |
| option(optionName, optionValue) | Updates the value of a single option. |
| option(options) | Updates the values of several options. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Repaints the widget. Call it if you made modifications that changed the widget's state to invalid. |
| reset() | Resets the value option to null. |
Events
This section describes events fired by this widget.
| Name | Description |
|---|---|
| contentReady | Raised when the widget's content is ready. |
| disposing | Raised before the widget is disposed of. |
| initialized | Raised only once, after the widget is initialized. |
| optionChanged | Raised after a widget option is changed. |
| valueChanged | Raised after the widget's value is changed. |