Free Trial Buy

Events

This section describes events fired by this widget.

See Also

change

Raised when the element loses focus after the content has been changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onChange

See Also

closed

Raised once the drop-down editor is closed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

Main article: onClosed

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only when using Knockout.

Main article: onContentReady.

See Also

customItemCreating

Raised when a user adds a custom item.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

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.

Main article: onCustomItemCreating

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

enterKey

Raised when the Enter key has been pressed while the widget is focused.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onEnterKey

See Also

focusIn

Raised when the widget gets focus.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onFocusIn

See Also

focusOut

Raised when the widget gets focus.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onFocusOut

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

input

Raised each time the widget's input is changed while the widget is focused.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onInput

See Also

itemClick

Raised when a list item is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

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 }.

event:

Event (jQuery or dxEvent)

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

Main article: onItemClick

See Also

keyDown

Raised when a user is pressing a key on the keyboard.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onKeyDown

See Also

keyPress

Raised when a user presses a key on the keyboard.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onKeyPress

See Also

keyUp

Raised when a user releases a key on the keyboard.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

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

event:

Event (jQuery or dxEvent)

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

Main article: onKeyUp

See Also

multiTagPreparing

Raised before the multi-tag is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only when using Knockout.

multiTagElement:

Element (jQuery or HTML)

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

Raised once the drop-down editor is opened.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

Main article: onOpened

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The 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

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

selectAllValueChanged

Raised when the "Select All" check box value is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

The model data. Available only if Knockout is used.

value:

Boolean

The "Select All" check box's state.

Main article: onSelectAllValueChanged

See Also

selectionChanged

Raised when a list item is selected or the selection is canceled.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

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.

Main article: onSelectionChanged

See Also

valueChanged

Raised after the widget's value is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

TagBox

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

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

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

event:

Event (jQuery or dxEvent)

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

Main article: onValueChanged

See Also