Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:
rule:

Object

An object specifying default options for the component and the device for which the options must be applied.

Object structure:
device:

Object

|

Array

|

function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options:

Object

A configuration object with specified options.

The defaultOptions method is a static method supported by the widget class. The following code demonstrates how to specify default options for all instances of the Switch widget in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxSwitch.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Switch options
    }
});
Angular
TypeScript
import Switch from 'devextreme/ui/switch';
// ...
export class AppComponent {
    constructor () {
        var switch: any = Switch;
        switch.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Switch options
            }
        });
    }
}

element()

Gets the root element of the widget.

Return Value:

jQuery

The root element of the widget.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

focus()

Sets focus on the widget.

See Also

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value:

Object

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

Return Value:

Object

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName:

String

The name of the event to unsubscribe from.

eventHandler:

function

The handler to be detached from the specified event.

Return Value:

Object

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName:

String

The name of the event to be subscribed.

eventHandler:

function

An event handler for the specified event.

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to the specified events.

Parameters:
events:

Object

An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Object

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value:

Object

The widget's options.

option(optionName)

Gets a specific option value.

Parameters:
optionName:

String

The option name or the full path to the option.

Return Value: any

This option value.

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName:

String

The option name or the full path to the option.

optionValue: any

A new value for this option.

option(options)

Sets one or more options.

Parameters:
options:

Object

The options along with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key:

String

The key for which the handler should be registered.

handler:

function

A handler.

The key argument accepts one of the following values:

  • "backspace"
  • "tab"
  • "enter"
  • "escape"
  • "pageUp"
  • "pageDown"
  • "end"
  • "home"
  • "leftArrow"
  • "upArrow"
  • "rightArrow"
  • "downArrow"
  • "del"
  • "space"
  • "F"
  • "A"
  • "asterisk"
  • "minus"

A custom handler for a key cancels the default handler for this key.

See Also

repaint()

Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.

See Also

reset()

Resets the value option to the default value.

See Also