<kendo:listBox>

A JSP wrapper for Kendo UI ListBox.

Configuration Attributes

autoBind boolean

If set to false, the widget will not bind to the data source during initialization. In this case, the data binding will occur when the change event of the data source is fired. By default, the ListBox will bind to the data source that is specified in the configuration.

Example

<kendo:listBox autoBind="autoBind">
</kendo:listBox>

connectWith java.lang.String

The id of the target ListBox to which items from the source ListBox will be transferred and vice versa. If you have to transfer items from the target ListBox over its toolbar, then you also need to set its connectWith option.

Example

<kendo:listBox connectWith="connectWith">
</kendo:listBox>

dataTextField java.lang.String

The field of the data item that provides the text content of the list items. Based on this field, the widget filters the data source.

Example

<kendo:listBox dataTextField="dataTextField">
</kendo:listBox>

dataValueField java.lang.String

The field of the data item that provides the value of the widget.

Example

<kendo:listBox dataValueField="dataValueField">
</kendo:listBox>

draggable boolean

Indicates whether the ListBox items can be dragged and dropped. Further configuration is available via kendo:listBox-draggable.

Example

<kendo:listBox draggable="draggable">
</kendo:listBox>

dropSources java.lang.Object

Array of id strings which determines the ListBoxes that can drag and drop their items to the current ListBox. The dropSources option describes a one way relationship. If you want a two-way connection, then set the dropSources option on both widgets.

Example

<kendo:listBox dropSources="dropSources">
</kendo:listBox>

Indicates whether the keyboard navigation is enabled or disabled.

Example

<kendo:listBox navigatable="navigatable">
</kendo:listBox>

selectable java.lang.String

Indicates whether the selection is single or multiple. The possible values are: - "single" - A single-item selection. - "multiple" - A multiple-item selection.

Example

<kendo:listBox selectable="selectable">
</kendo:listBox>

template java.lang.String

Specifies the item template of the ListBox.

Example

<kendo:listBox template="template">
</kendo:listBox>

Configuration JSP Tags

kendo:listBox-draggable

Indicates whether the ListBox items can be dragged and dropped.

More documentation is available at kendo:listBox-draggable.

Example

<kendo:listBox>
    <kendo:listBox-draggable></kendo:listBox-draggable>
</kendo:listBox>

kendo:listBox-messages

Defines the localization texts for the ListBox. Used primarily for localization.

More documentation is available at kendo:listBox-messages.

Example

<kendo:listBox>
    <kendo:listBox-messages></kendo:listBox-messages>
</kendo:listBox>

kendo:listBox-toolbar

Defines the settings for displaying the toolbar of the ListBox. The toolbar allows you to execute a set of predefined actions.By default, the toolbar is not displayed. If the tools array is populated, then the toolbar and the corresponding tools are displayed.

More documentation is available at kendo:listBox-toolbar.

Example

<kendo:listBox>
    <kendo:listBox-toolbar></kendo:listBox-toolbar>
</kendo:listBox>

Event Attributes

add String

Fires before an item is added to the ListBox.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the add event documentation.

Example

<kendo:listBox add="handle_add">
</kendo:listBox>
<script>
    function handle_add(e) {
        // Code to handle the add event.
    }
</script>

change String

Fires when the ListBox selection has changed.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the change event documentation.

Example

<kendo:listBox change="handle_change">
</kendo:listBox>
<script>
    function handle_change(e) {
        // Code to handle the change event.
    }
</script>

dataBound String

Fires when the ListBox has received data from the data source and is already rendered.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the dataBound event documentation.

Example

<kendo:listBox dataBound="handle_dataBound">
</kendo:listBox>
<script>
    function handle_dataBound(e) {
        // Code to handle the dataBound event.
    }
</script>

dragstart String

Fires when the dragging of the ListBox items starts.

For additional information check the dragstart event documentation.

Example

<kendo:listBox dragstart="handle_dragstart">
</kendo:listBox>
<script>
    function handle_dragstart(e) {
        // Code to handle the dragstart event.
    }
</script>

drag String

Fires when the placeholder of the ListBox changes its position.

For additional information check the drag event documentation.

Example

<kendo:listBox drag="handle_drag">
</kendo:listBox>
<script>
    function handle_drag(e) {
        // Code to handle the drag event.
    }
</script>

drop String

Fires when a ListBox item is dropped over one of the drop targets.

For additional information check the drop event documentation.

Example

<kendo:listBox drop="handle_drop">
</kendo:listBox>
<script>
    function handle_drop(e) {
        // Code to handle the drop event.
    }
</script>

dragend String

Fires when the dragging of the item ends but before its position is changed in the DOM.

For additional information check the dragend event documentation.

Example

<kendo:listBox dragend="handle_dragend">
</kendo:listBox>
<script>
    function handle_dragend(e) {
        // Code to handle the dragend event.
    }
</script>

remove String

Fires before an item is removed from the ListBox.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the remove event documentation.

Example

<kendo:listBox remove="handle_remove">
</kendo:listBox>
<script>
    function handle_remove(e) {
        // Code to handle the remove event.
    }
</script>

reorder String

Fires when ListBox items are reordered.

For additional information check the reorder event documentation.

Example

<kendo:listBox reorder="handle_reorder">
</kendo:listBox>
<script>
    function handle_reorder(e) {
        // Code to handle the reorder event.
    }
</script>

Event Tags

kendo:listBox-add

Fires before an item is added to the ListBox.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the add event documentation.

Example

<kendo:listBox>
    <kendo:listBox-add>
        <script>
            function(e) {
                // Code to handle the add event.
            }
        </script>
    </kendo:listBox-add>
</kendo:listBox>

kendo:listBox-change

Fires when the ListBox selection has changed.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the change event documentation.

Example

<kendo:listBox>
    <kendo:listBox-change>
        <script>
            function(e) {
                // Code to handle the change event.
            }
        </script>
    </kendo:listBox-change>
</kendo:listBox>

kendo:listBox-dataBound

Fires when the ListBox has received data from the data source and is already rendered.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the dataBound event documentation.

Example

<kendo:listBox>
    <kendo:listBox-dataBound>
        <script>
            function(e) {
                // Code to handle the dataBound event.
            }
        </script>
    </kendo:listBox-dataBound>
</kendo:listBox>

kendo:listBox-dragstart

Fires when the dragging of the ListBox items starts.

For additional information check the dragstart event documentation.

Example

<kendo:listBox>
    <kendo:listBox-dragstart>
        <script>
            function(e) {
                // Code to handle the dragstart event.
            }
        </script>
    </kendo:listBox-dragstart>
</kendo:listBox>

kendo:listBox-drag

Fires when the placeholder of the ListBox changes its position.

For additional information check the drag event documentation.

Example

<kendo:listBox>
    <kendo:listBox-drag>
        <script>
            function(e) {
                // Code to handle the drag event.
            }
        </script>
    </kendo:listBox-drag>
</kendo:listBox>

kendo:listBox-drop

Fires when a ListBox item is dropped over one of the drop targets.

For additional information check the drop event documentation.

Example

<kendo:listBox>
    <kendo:listBox-drop>
        <script>
            function(e) {
                // Code to handle the drop event.
            }
        </script>
    </kendo:listBox-drop>
</kendo:listBox>

kendo:listBox-dragend

Fires when the dragging of the item ends but before its position is changed in the DOM.

For additional information check the dragend event documentation.

Example

<kendo:listBox>
    <kendo:listBox-dragend>
        <script>
            function(e) {
                // Code to handle the dragend event.
            }
        </script>
    </kendo:listBox-dragend>
</kendo:listBox>

kendo:listBox-remove

Fires before an item is removed from the ListBox.The function context of the event handler (available through the this keyword) that will be set to the widget instance.

For additional information check the remove event documentation.

Example

<kendo:listBox>
    <kendo:listBox-remove>
        <script>
            function(e) {
                // Code to handle the remove event.
            }
        </script>
    </kendo:listBox-remove>
</kendo:listBox>

kendo:listBox-reorder

Fires when ListBox items are reordered.

For additional information check the reorder event documentation.

Example

<kendo:listBox>
    <kendo:listBox-reorder>
        <script>
            function(e) {
                // Code to handle the reorder event.
            }
        </script>
    </kendo:listBox-reorder>
</kendo:listBox>
In this article
Related articles
Not finding the help you need?