ListBox

Example

<kendo-listbox>
    <datasource></datasource>
    <draggable />
    <messages />
    <toolbar></toolbar>
</kendo-listbox>

ChildTags

Tag Name Details
datasource DataSourceTagHelper
draggable ListBoxDraggableSettingsTagHelper
messages ListBoxMessagesSettingsTagHelper
toolbar ListBoxToolbarSettingsTagHelper

Attributes

Attribute Type Description
name String Sets the name of the component.
as-child-component Boolean
connect-with 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.
deferred Boolean Suppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
bind-to IEnumerable<Object> The collection of data items which the data source contains.
is-in-client-template Boolean When placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
as-module Boolean
auto-bind 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.
datasource-id String The Id of the data source.
data-text-field 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.
data-value-field String The field of the data item that provides the value of the widget.
drop-sources String[] 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.
has-client-component Boolean
navigatable Boolean Indicates whether the keyboard navigation is enabled or disabled.
on-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.
on-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.
on-data-bound 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.
on-drag String Fires when the dragging of the ListBox items starts.
on-dragend String Fires when the dragging of the item ends but before its position is changed in the DOM.
on-dragstart String Fires when the dragging of the ListBox items starts.
on-drop String Fires when a ListBox item is dropped over one of the drop targets.
on-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.
on-reorder String Fires when ListBox items are reordered.
sanitize-id Boolean
script-attributes IDictionary<String,Object>
selectable ListBoxSelectable Represents the selectable options.
template String Specifies the item template of the ListBox.
template-handler String Specifies the item template of the ListBox.
template-id String Specifies the item template of the ListBox.
template-view IHtmlContent Specifies the item template of the ListBox.
In this article
Not finding the help you need?