Events

This section describes events that the ButtonGroup widget raises.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Main article: onContentReady.

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The widget instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Main article: onDisposing

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

See Also

itemClick

Raised when a button is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The widget's instance.

element

Element (jQuery or HTML)

The widget's container.

event

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The clicked button's data.

itemElement

Element (jQuery or HTML)

The button's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex

Number

The clicked button's index.

model

Object

Model data. Available only if you use Knockout.

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

ButtonGroup

The widget's instance.

fullName

String

The path to the modified option that includes all parent options.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

selectionChanged

Raised when a button is selected or selection is canceled.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
addedItems

Array<any>

The data objects that correspond to the selected buttons.

component

ButtonGroup

The widget's instance.

element

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

removedItems

Array<any>

The data objects that correspond to the buttons whose selection has been canceled.
The objects are taken from the items array.

Main article: onSelectionChanged

See Also