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
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device 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 RadioGroup widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxRadioGroup.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RadioGroup options } });
Angular
import RadioGroup from 'devextreme/ui/radio_group'; // ... export class AppComponent { constructor () { RadioGroup.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RadioGroup options } }); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
focus()
Sets focus on the widget.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
The following code gets the RadioGroup instance found in an element with ID myRadioGroup
:
// Modular approach import RadioGroup from 'devextreme/ui/radio_group'; ... let element = document.getElementById("myRadioGroup"); let instance = RadioGroup.getInstance(element); // Non-modular approach let element = document.getElementById("myRadioGroup"); let instance = DevExpress.ui.dxRadioGroup.getInstance(element);
See Also
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
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
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
repaint()
Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
reset()
Resets the value option to the default value.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC