ListBoxTagHelper

Example

Razor

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

ChildTags

Tag Name	Details
datasource	DataSourceTagHelper
draggable	ListBoxDraggableSettingsTagHelper
item-template	TemplateTagHelper
messages	ListBoxMessagesSettingsTagHelper
toolbar	ListBoxToolbarSettingsTagHelper

Attributes

Attribute	Type	Description
name	String	Sets the name of the component.
as-module	Boolean	Specifies whether the initialization script of the component will be rendered as a JavaScript module.
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.
deferred	Boolean	Suppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
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.
bind-to	IEnumerable<Object>	The collection of data items which the data source contains.
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.
datasource-id	String	The Id of the data source.
datatextfield	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.
datavaluefield	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.
navigatable	Boolean	Indicates whether the keyboard navigation is enabled or disabled.
on-add	String	The name of the JavaScript function that will handle the add event. 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	The name of the JavaScript function that will handle the change event. 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	The name of the JavaScript function that will handle the dataBound event. 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	The name of the JavaScript function that will handle the dragstart event. Fires when the dragging of the ListBox items starts.
on-dragend	String	The name of the JavaScript function that will handle the dragend event. Fires when the dragging of the item ends but before its position is changed in the DOM.
on-dragstart	String	The name of the JavaScript function that will handle the dragstart event. Fires when the dragging of the ListBox items starts.
on-drop	String	The name of the JavaScript function that will handle the drop event. Fires when a ListBox item is dropped over one of the drop targets.
on-remove	String	The name of the JavaScript function that will handle the remove event. 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	The name of the JavaScript function that will handle the reorder event. Fires when ListBox items are reordered.
script-attributes	IDictionary<String,Object>	Sets the attributes that will be added to the script tag of the component's initialization script.
selectable	ListBoxSelectable	Represents the selectable options.
template	String	Represents a collection of templates defined for the component.
template-handler	String	Specifies the item template of the ListBox. This option expects the name of a JavaScript function that will be called to return the template.
template-id	String	Specifies the item template of the ListBox. This option expects the ID of the script element that contains the template.
template-view	IHtmlContent	Specifies the item template of the ListBox. This option expects the instance containing the created HTML.