jQuery RadioGroup API
The RadioGroup is a widget that contains a set of radio buttons and allows an end user to make a single selection from the set.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
| dataSource |
Binds the widget to data. |
| disabled |
Specifies whether the widget responds to user interaction. |
| displayExpr |
Specifies the data field whose values should be displayed. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| isValid |
Specifies or indicates whether the editor's value is valid. |
| itemComponent |
An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemRender |
An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items |
An array of items displayed by the widget. |
| itemTemplate |
Specifies a custom template for items. |
| layout |
Specifies the radio group layout. |
| name |
The value to be assigned to the |
| onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing |
A function that is executed before the widget is disposed of. |
| onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
| onOptionChanged |
A function that is executed after a widget option is changed. |
| onValueChanged |
A function that is executed after the widget's value is changed. |
| readOnly |
Specifies whether the editor is read-only. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| validationError |
Information on the broken validation rule. Contains the first item from the validationErrors array. |
| validationErrors |
An array of the validation rules that failed. |
| validationMessageMode |
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
| validationStatus |
Indicates or specifies the current validation status. |
| value |
Specifies the widget's value. |
| valueExpr |
Specifies which data field provides unique values to the widget's value. |
| visible |
Specifies whether the widget is visible. |
| width |
Specifies the widget's width. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the RadioGroup instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
| reset() |
Resets the value option to the default value. |
| resetOption(optionName) |
Resets an option to its default value. |
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the widget's content is ready. |
| disposing |
Raised before the widget is disposed of. |
| initialized |
Raised only once, after the widget is initialized. |
| optionChanged |
Raised after a widget option is changed. |
| valueChanged |
Raised after the widget's value is changed. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core