React TagBox Events

This section describes events fired by this widget.

See Also

change

Fires when a change within the widget's input element is committed by an end user.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onChange option to handle the event.

See Also

closed

Fires after a drop-down list has been hidden.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.

Instead, you can use the onClosed option to handle the event.

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

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only when using Knockout.

Main article: onContentReady.

See Also

copy

Fires after the widget's input has been copied.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onCopy option to handle the event.

See Also

customItemCreating

Raised when a user adds a custom item.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if you use Knockout.
text

String

The input field's text.
customItem

String

|

Object

|

Promise<any> (jQuery or native)

The field where to place a custom item.
Return Value:

String

|

Object

|

Promise<any> (jQuery or native)

A custom item or a Promise that is resolved after the item is created. It is a native Promise or a jQuery.Promise when you use jQuery.

Main article: onCustomItemCreating

See Also

cut

Fires after the Cut DOM event has fired.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onCut option to handle the event.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if you use Knockout.

See Also

enterKey

Fires after the Enter key has been pressed within the widget's input element.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onEnterKey option to handle the event.

See Also

focusIn

Fires after the widget's input has been focused.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Use the on() method to attach a handler for the focusIn event.

To unsubscribe from this event, use the off() method.

Note that you can handle the focusIn event within the widget's configuration object by assigning your handler to the onFocusIn option.

See Also

focusOut

Fires after the widget's input element has lost focus.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onFocusOut option to handle the event.

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

Object

The widget's instance.
element

HTMLElement | jQuery

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

Main article: onInitialized

See Also

input

Fires when a value within the widget's input element is changed by an end user.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onInput option to handle the event.

See Also

itemClick

Fires when a widget item is clicked.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
itemData

Object

The clicked item's data.
itemElement

Object

The item's container.
itemIndex

Number

|

Object

The clicked item's index. If the widget items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Instead, you can use the onItemClick option to handle the event.

See Also

keyDown

Fires when a key is pressed down within the widget's input element.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onKeyDown option to handle the event.

See Also

keyPress

Fires when the keypress DOM event has been raised for the current input element.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onKeyPress option to handle the event.

See Also

keyUp

Fires when a key is released within the widget's input element.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onKeyUp option to handle the event.

See Also

multiTagPreparing

Raised before the multi-tag is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only when using Knockout.
multiTagElement

HTMLElement | jQuery

The multi-tag's container. It is an HTML Element or a jQuery Element when you use jQuery.
selectedItems

Array<String | Number | Object>

The currently selected items.
text

String

Allows you to change the multi-tag's text.
cancel

Boolean

Allows you to cancel replacing ordinary tags with the multi-tag.

Main article: onMultiTagPreparing

See Also

opened

Fires when the drop-down editor is shown.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.

Instead, you can use the onOpened option to handle the event.

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
name

String

The option's short name.
model

Object

The model data. Available only if you use Knockout.
element

HTMLElement | jQuery

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

Object

The widget's instance.
fullName

String

The option's full name.
value any

The option's new value.

See Also

paste

Fires after the widget's input has been pasted.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onPaste option to handle the event.

See Also

selectAllValueChanged

Fires when the select all check box value changes.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
value

Boolean

The "Select All" check box's state.

Instead, you can use the onSelectAllValueChanged option to handle the event.

NOTE
This event fires only if the showSelectionControls option is set to true.
See Also

selectionChanged

Fires when the selection changes.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
addedItems

Array<String | Number | Object>

The data of the items that have been selected.
removedItems

Array<String | Number | Object>

The data of the items whose selection has been canceled.

Instead, you can use the onSelectionChanged option to handle the event.

See Also

valueChanged

Fires when the editor value changes.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Object

The model data. Available only if Knockout is used.
value

Object

Returns the widget's new value.
previousValue

Object

Returns the widget's previous value.
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Instead, you can use the onValueChanged option to handle the event.

See Also