Configuration

An object defining configuration options for the dxCheckBox widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type:

String

Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: true

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

Show Example:
AngularJS
Knockout
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type:

Boolean

Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
AngularJS
Knockout
jQuery

focusStateEnabled

Specifies whether or not the widget can be focused.

Type:

Boolean

Default Value: false
Default for generic: true

height

Specifies the height of the widget container.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

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 the text of the hint displayed for the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type:

Boolean

Default Value: true

isValid

Specifies whether the editor's value is valid.

Type:

Boolean

Default Value: true

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code below, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{
                type: 'required',
                message: 'Login is required'
            }]
        }
    }),
    //...
}
NOTE
The editor's isValid option, as well as the validationError option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.
See Also

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onValueChanged

A handler for the valueChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

value:

Object

The widget's new value.

previousValue:

Object

The widget's previous value.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when the editor value changes.

Show Example:
AngularJS
Knockout
jQuery

readOnly

A Boolean value specifying whether or not the widget is read-only.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type:

Boolean

Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

tabIndex

Specifies the widget tab index.

Type:

Number

Default Value: 0

text

Specifies the text displayed by the check box.

Type:

String

Default Value: ''

Show Example:
AngularJS
Knockout
jQuery

validationError

Holds the object that defines the error that occurred during validation.

Type:

Object

Default Value: undefined

You may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's validationError option, as well as the isValid option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.

See Also

validationMessageMode

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

Type:

String

Default Value: 'auto'
Accepted Values: 'auto' | 'always'

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.

value

Specifies the widget state.

Type:

Boolean

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 Enter or Space key.

Show Example:
AngularJS
Knockout
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the width of the widget container.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget width.

Default Value: undefined

The option can hold a value of the following types.

  • number
    The width of the widget in pixels

  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget width (e.g., width: function(){ return baseWidth - 10 + "%"; })

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;
}