ListBox

Example

Razor
<kendo-listbox>
    <datasource></datasource>
    <draggable />
    <item-template></item-template>
    <messages />
    <toolbar></toolbar>
</kendo-listbox>

ChildTags

Attributes

AttributeTypeDescription
nameStringSets the name of the component.
connect-withStringThe 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.
deferredBooleanSuppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
is-in-client-templateBooleanWhen placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
as-moduleBoolean
auto-bindBooleanIf 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.
bind-toIEnumerable<Object>The collection of data items which the data source contains.
datasource-idStringThe Id of the data source.
data-text-fieldStringThe 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-fieldStringThe field of the data item that provides the value of the widget.
drop-sourcesString[]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-componentBoolean
navigatableBooleanIndicates whether the keyboard navigation is enabled or disabled.
on-addStringFires 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-changeStringFires 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-boundStringFires 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-dragStringFires when the dragging of the ListBox items starts.
on-dragendStringFires when the dragging of the item ends but before its position is changed in the DOM.
on-dragstartStringFires when the dragging of the ListBox items starts.
on-dropStringFires when a ListBox item is dropped over one of the drop targets.
on-removeStringFires 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-reorderStringFires when ListBox items are reordered.
sanitize-idBoolean
script-attributesIDictionary<String,Object>
selectableListBoxSelectableRepresents the selectable options.
templateStringSpecifies the item template of the ListBox.
template-handlerStringSpecifies the item template of the ListBox.
template-idStringSpecifies the item template of the ListBox.
template-viewIHtmlContentSpecifies the item template of the ListBox.
In this article
ExampleChildTagsAttributes
Not finding the help you need?
Contact Support