Configuration

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#checkBoxContainer").dxCheckBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-check-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-check-box>

import { DxCheckBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxCheckBoxModule
    ],
    // ...
})

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().CheckBox()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().CheckBox() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Default Value: false, true (desktop)

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

NOTE

The option affects only the size of the widget container. To specify the size of a check box icon, provide the appropriate CSS rules.

CSS

#checkBoxContainer .dx-checkbox-icon{
    height: 20px;
    width: 20px;
}

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Default Value: true

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Default Value: true

NOTE

When you use async rules, isValid is true if the status is "pending" or "valid".

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

Default Value: ''

Specify this option if the widget lies within an HTML form that will be submitted.

If you configure the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

CheckBox

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

CheckBox

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

CheckBox

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	CheckBox	The widget's instance.
fullName	String	The path to the modified option that includes all parent options.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if you use Knockout.

Default Value: null

onValueChanged

A function that is executed after the widget's value is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	CheckBox	The widget's instance.
element	Element (jQuery or HTML)	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or dxEvent)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	Model data. Available only if Knockout is used.
previousValue	Object	The widget's previous value.
value	Object	The widget's new value.

Default Value: null

readOnly

Specifies whether the editor is read-only.

Type:

Default Value: false

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

text

Specifies the text displayed by the check box.

Type:

Default Value: ''

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type:

Default Value: null

validationErrors

An array of the validation rules that failed.

Type:

Array<Object>

Default Value: null

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

Default Value: 'auto'

Accepted Values: 'always' | 'auto'

The following option values are possible:

auto
The tooltip with the message is displayed when the editor is in focus.
always
The tooltip with the message is not hidden when the editor loses focus.

Use the ValidationMessageMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto and Always.

validationStatus

Indicates or specifies the current validation status.

Type:

Default Value: 'valid'

Accepted Values: 'valid' | 'invalid' | 'pending'

The following table illustrates the validation status indicators:

validationStatus	Indicator
`"pending"`
`"valid"`
`"invalid"`

value

Specifies the widget state.

Type:

Default Value: false

The check box can be in one of the following states depending on the value option value.

checked
value is true
unchecked
value is false
undetermined
value is undefined

An end-user can change the widget value using the Space key.

View Demo

visible

Specifies whether the widget is visible.

Type: