Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ListBoxBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ListBoxBuilder

Class

Defines the fluent API for configuring the Kendo ListBox for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class ListBoxBuilder : WidgetBuilderBase<ListBox, ListBoxBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ListBox, ListBoxBuilder>ListBoxBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<ListBox, ListBoxBuilder>.ToComponent()WidgetBuilderBase<ListBox, ListBoxBuilder>.Name(string)WidgetBuilderBase<ListBox, ListBoxBuilder>.Deferred(bool)WidgetBuilderBase<ListBox, ListBoxBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<ListBox, ListBoxBuilder>.HtmlAttributes(object)WidgetBuilderBase<ListBox, ListBoxBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<ListBox, ListBoxBuilder>.AsModule(bool)WidgetBuilderBase<ListBox, ListBoxBuilder>.Render()WidgetBuilderBase<ListBox, ListBoxBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<ListBox, ListBoxBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<ListBox, ListBoxBuilder>.ToHtmlString()WidgetBuilderBase<ListBox, ListBoxBuilder>.ToClientTemplate()WidgetBuilderBase<ListBox, ListBoxBuilder>.ToString()WidgetBuilderBase<ListBox, ListBoxBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ListBoxBuilder(ListBox)

Initializes a new instance of the ListBox class.

C#
public ListBoxBuilder(ListBox component)
Parameters:componentListBox

The component.

Methods

AutoBind(bool)

If set to false, the component 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.

C#
public ListBoxBuilder AutoBind(bool value)
Parameters:valuebool

The value that configures the autobind.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.AutoBind(true)
)

BindTo(IEnumerable)

Binds the ListBox to an IEnumerable list.

C#
public ListBoxBuilder BindTo(IEnumerable data)
Parameters:dataIEnumerable

The data source.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.BindTo(ViewBag.Attendees)
)

BindTo(IEnumerable<SelectListItem>)

Binds the ListBox to a list of SelectListItem.

C#
public ListBoxBuilder BindTo(IEnumerable<SelectListItem> dataSource)
Parameters:dataSourceIEnumerable<SelectListItem>

The data source.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.BindTo(new List&lt;SelectListItem&gt;() {
new SelectListItem()
{
Text = "Cotton", Value = "1"
},
new SelectListItem()
{
Text = "Polyester", Value = "2"
}
})
)

ConnectWith(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.

C#
public ListBoxBuilder ConnectWith(string value)
Parameters:valuestring

The value that configures the connectwith.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.ConnectWith("Value")
)

DataSource(Action<ReadOnlyDataSourceBuilder>)

Sets the data source configuration of the ListBox.

C#
public ListBoxBuilder DataSource(Action<ReadOnlyDataSourceBuilder> configurator)
Parameters:configuratorAction<ReadOnlyDataSourceBuilder>

The lambda which configures the data source

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.DataSource(source =&gt; source
.Read(read =&gt; read.Action("GetCustomers", "ListBox"))
)
)

DataSource(string)

Sets the data source of the ListBox.

C#
public ListBoxBuilder DataSource(string dataSourceId)
Parameters:dataSourceIdstring

The name of the data source

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.DataSource("dataSource")
)

DataTextField(string)

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

C#
public ListBoxBuilder DataTextField(string value)
Parameters:valuestring

The value that configures the datatextfield.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.DataTextField("Value")
)

DataValueField(string)

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

C#
public ListBoxBuilder DataValueField(string value)
Parameters:valuestring

The value that configures the datavaluefield.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.DataValueField("Value")
)

Draggable()

Indicates whether the ListBox items can be dragged and dropped.

C#
public ListBoxBuilder Draggable()
Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Draggable()
)

Draggable(Action<ListBoxDraggableSettingsBuilder>)

Indicates whether the ListBox items can be dragged and dropped.

C#
public ListBoxBuilder Draggable(Action<ListBoxDraggableSettingsBuilder> configurator)
Parameters:configuratorAction<ListBoxDraggableSettingsBuilder>

The action that configures the draggable.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Draggable(d =&gt; d.Hint("Value"))
)

Draggable(bool)

Indicates whether the ListBox items can be dragged and dropped.

C#
public ListBoxBuilder Draggable(bool enabled)
Parameters:enabledbool

Enables or disables the draggable option.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Draggable(true)
)

DropSources(params 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 components.

C#
public ListBoxBuilder DropSources(params string[] value)
Parameters:valuestring[]

The value that configures the dropsources.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.DropSources("Value 1", "Value 2")
)

Events(Action<ListBoxEventBuilder>)

Configures the client-side events.

C#
public ListBoxBuilder Events(Action<ListBoxEventBuilder> configurator)
Parameters:configuratorAction<ListBoxEventBuilder>

The client events action.

Returns:

ListBoxBuilder

Example:
C#
@( Html.Kendo().ListBox()
.Name("listBox")
.Events(events =&gt; events
.Change("handler")
)
)

Messages(Action<ListBoxMessagesSettingsBuilder>)

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

C#
public ListBoxBuilder Messages(Action<ListBoxMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<ListBoxMessagesSettingsBuilder>

The action that configures the messages.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Messages(m =&gt; m.Tools(t=&gt;t.MoveDown("Value")))
)

Navigatable(bool)

Indicates whether the keyboard navigation is enabled or disabled.

C#
public ListBoxBuilder Navigatable(bool value)
Parameters:valuebool

The value that configures the navigatable.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Navigatable(true)
)

Selectable(ListBoxSelectable)

Represents the selectable options.

C#
public ListBoxBuilder Selectable(ListBoxSelectable value)
Parameters:valueListBoxSelectable

The value for Selectable

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Selectable(ListBoxSelectable.Single)
)

Template(string)

Specifies the item template of the ListBox.

C#
public ListBoxBuilder Template(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Template("Value")
)

Template<TModel>(TemplateBuilder<TModel>)

Specifies the item template of the ListBox.

C#
public ListBoxBuilder Template<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

ListBoxBuilder

TemplateHandler(string)

Specifies the item template of the ListBox.

C#
public ListBoxBuilder TemplateHandler(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.TemplateHandler("Value")
)

TemplateId(string)

Specifies the item template of the ListBox.

C#
public ListBoxBuilder TemplateId(string value)
Parameters:valuestring

The value that configures the template.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.TemplateId("Value")
)

TemplateView(MvcHtmlString)

Specifies the item template of the ListBox.

C#
public ListBoxBuilder TemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.TemplateView(Html.Partial("TemplateView"))
)

Toolbar(Action<ListBoxToolbarSettingsBuilder>)

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.

C#
public ListBoxBuilder Toolbar(Action<ListBoxToolbarSettingsBuilder> configurator)
Parameters:configuratorAction<ListBoxToolbarSettingsBuilder>

The action that configures the toolbar.

Returns:

ListBoxBuilder

Example:
C#
@(Html.Kendo().ListBox()
.Name("listBox")
.Toolbar(toolbar =&gt;
{
toolbar.Position(Kendo.Mvc.UI.Fluent.ListBoxToolbarPosition.Right);
})
)
In this article
DefinitionConstructorsListBoxBuilder(ListBox)MethodsAutoBind(bool)BindTo(IEnumerable)BindTo(IEnumerable<SelectListItem>)ConnectWith(string)DataSource(Action<ReadOnlyDataSourceBuilder>)DataSource(string)DataTextField(string)DataValueField(string)Draggable()Draggable(Action<ListBoxDraggableSettingsBuilder>)Draggable(bool)DropSources(params string[])Events(Action<ListBoxEventBuilder>)Messages(Action<ListBoxMessagesSettingsBuilder>)Navigatable(bool)Selectable(ListBoxSelectable)Template(string)Template<TModel>(TemplateBuilder<TModel>)TemplateHandler(string)TemplateId(string)TemplateView(MvcHtmlString)Toolbar(Action<ListBoxToolbarSettingsBuilder>)
Not finding the help you need?
Contact Support