JavaScript/jQuery TagBox Events

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onChange

closed

Raised once the drop-down editor is closed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if Knockout is used.

Main article: onClosed

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only when using Knockout.

Main article: onContentReady.

customItemCreating

Raised when a user adds a custom item.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onCustomItemCreating

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Name

Type

Description

component

The widget instance.

element

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

model

The model data. Available only if you use Knockout.

Main article: onDisposing

enterKey

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onEnterKey

focusIn

Raised when the widget gets focus.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TagBox	The widget's instance.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Main article: onFocusIn

focusOut

Raised when the widget loses focus.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TagBox	The widget's instance.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Main article: onFocusOut

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

Main article: onInitialized

input

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onInput

itemClick

Raised when a list item is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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 }.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Main article: onItemClick

keyDown

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onKeyDown

keyPress

Raised when a user presses a key on the keyboard.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onKeyPress

keyUp

Raised when a user releases a key on the keyboard.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onKeyUp

multiTagPreparing

Raised before the multi-tag is rendered.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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

opened

Raised once the drop-down editor is opened.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if Knockout is used.

Main article: onOpened

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
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	TagBox	The widget's instance.
fullName	String	The path to the modified option that includes all parent options.
value	any	The modified option's new value.

Main article: onOptionChanged

selectAllValueChanged

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TagBox	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.

Main article: onSelectAllValueChanged

selectionChanged

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
addedItems	Array<String \| Number \| Object>	The data of the items that have been selected.
model	Object	The model data. Available only if Knockout is used.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TagBox	The widget's instance.
removedItems	Array<String \| Number \| Object>	The data of the items whose selection has been canceled.

Main article: onSelectionChanged

valueChanged

Raised after the widget's value is changed.

Type:

Event

Function parameters:

e: