Configuration

An object defining configuration options for the Switch widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type: String
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: 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

Specifies whether the widget responds to user interaction.

Type: Boolean
Default Value: false

Show Example:
AngularJS
Knockout
jQuery

elementAttr

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

Type: Object
Default Value: {}

When you configure this option in an ASP.NET MVC Control, pass a dictionary as shown in the following code.

Razor C#
Razor VB
@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" },
        // ...
    })
)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

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 switch wrapper element. To specify the size of another switch elements, provide the appropriate CSS rules.

hint

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

Type: String
Default Value: undefined

hoverStateEnabled

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

Type: Boolean
Default Value: true

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

In Knockout apps, you may need to inform a user about an error that occurred during the validation of a view model field. For this purpose, set the editor's isValid option to the isValid value of the dxValidator that validates this field. To show an error message, set the editor's validationError option to the dxValidator's validationError value.

JavaScript
var editorValue = ko.observable("").extend({
    dxValidator: {
        validationRules: [{
            type: 'required',
            message: 'Specify this value'
        }]
    }
});
var viewModel = {
    editorOptions: {
        value: editorValue,
        isValid: editorValue.dxValidator.isValid,
        validationError: editorValue.dxValidator.validationError
    }
};

The editor's isValid and validationError options 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

name

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

Type: String
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 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.

offText

Text displayed when the widget is in a disabled state.

Type: String
Default Value: 'OFF'
NOTE
The widget may or may not display text depending on the current theme.
Show Example:
AngularJS
Knockout
jQuery

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type: function
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.
Default Value: null

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type: function
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
Default Value: null

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type: function
Function parameters:
Information about the event.
Object structure:
component: Object
The widget instance.
name: String
A short name of the option whose value has been changed.
fullName: String
A full name of the option whose value has been changed; contains a full hierarchy of the option.
value: any
A new value for the option.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.
Default Value: null

onText

Text displayed when the widget is in an enabled state.

Type: String
Default Value: 'ON'
NOTE
The widget may or may not display text depending on the current theme.
Show Example:
AngularJS
Knockout
jQuery

onValueChanged

A handler for the valueChanged event.

Type: function
Function parameters:
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 approach.
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.

readOnly

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

Type: Boolean
Default Value: false

rtlEnabled

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

Type: Boolean
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.

validationError

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

Type: Object
Default Value: undefined

In Knockout apps, you may need to inform a user about an error that occurred during the validation of a view model field. For this purpose, set the editor's isValid option to the isValid value of the dxValidator that validates this field. To show an error message, set the editor's validationError option to the dxValidator's validationError value.

JavaScript
var editorValue = ko.observable("").extend({
    dxValidator: {
        validationRules: [{
            type: 'required',
            message: 'Specify this value'
        }]
    }
});
var viewModel = {
    editorOptions: {
        value: editorValue,
        isValid: editorValue.dxValidator.isValid,
        validationError: editorValue.dxValidator.validationError
    }
};

The editor's isValid and validationError options 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.

When using the widget as an ASP.NET MVC Control, specify this option using the ValidationMessageMode enum. This enum accepts the following values: Auto and Always.

value

A Boolean value specifying whether the current switch state is "On" or "Off".

Type: Boolean
Default Value: false

Show Example:
AngularJS
Knockout
jQuery

visible

Specifies whether the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String| function
Return Value: Number|String
The width of the widget.
Default Value: undefined

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

  • Number
    The width of the widget in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }