New to Telerik UI for ASP.NET MVC? Download free 30-day trial

MultiSelectBuilder

Defines the fluent interface for configuring the MultiSelect component.

Methods

AutoBind(System.Boolean)

Controls whether to bind the component to the DataSource on initialization.

Parameters

autoBind - System.Boolean

If true, enables binding on initialization.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .AutoBind(false)
            )

AutoWidth(System.Boolean)

Controls whether to adjust the popup width

Parameters

autoWidth - System.Boolean

If true, enables automatic popup width adjustment.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .AutoWidth(false)
            )

AutoClose(System.Boolean)

Controls whether to close the component suggestion list on item selection.

Parameters

autoClose - System.Boolean

If true, enables suggestion list auto-close.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .AutoClose(false)
            )

BindTo(System.Collections.Generic.IEnumerable)

Binds the MultiSelect to a list of DropDownListItem.

Parameters

dataSource - System.Collections.Generic.IEnumerable<DropDownListItem>

The data source.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .BindTo(new List<DropDownListItem>
                        {
                            new DropDownListItem{
                                Text = "Text1",
                                Value = "Value1"
                            },
                            new DropDownListItem{
                                Text = "Text2",
                                Value = "Value2"
                            } })
            )

BindTo(System.Collections.Generic.IEnumerable)

Binds the MultiSelect to a list of DropDownListItem.

Parameters

dataSource - System.Collections.Generic.IEnumerable<SelectListItem>

The data source.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .BindTo(new List<DropDownListItem>
                        {
                            new DropDownListItem{
                                Text = "Text1",
                                Value = "Value1"
                            },
                            new DropDownListItem{
                                Text = "Text2",
                                Value = "Value2"
                            } })
            )

ClearButton(System.Boolean)

Use to enable or disable clear button functionality.

Parameters

enable - System.Boolean

If true, a clear button is shown in the input.

Example


            @(Html.Kendo().MultiSelect()
                       .Name("MultiSelect")
                       .ClearButton(false)
            )

DataValueField(System.String)

Sets the field of the data item that provides the value content of the list items.

Parameters

field - System.String

The name of the field.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .DataTextField("Text")
                        .DataValueField("Value")
            )

DownArrow(System.Boolean)

Configures the MultiSelect to render a down arrow, clicking on which opens and closes the popup.

Parameters

value - System.Boolean

If true, a down arrow is rendered.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .DataTextField("Text")
                        .DataValueField("Value")
                        .DownArrow(false)
            )

DownArrow()

Configures the MultiSelect to render a down arrow, clicking on which opens and closes the popup.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .DataTextField("Text")
                        .DataValueField("Value")
                        .DownArrow(false)
            )

EnforceMinLength(System.Boolean)

If set to true the component will not show all items when the text of the search input cleared. By default the component shows all items when the text of the search input is cleared. Works in conjunction with minLength.

Parameters

enforceMinLength - System.Boolean

The boolean value.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .MinLength(3)
                        .Filter("contains")
                        .EnforceMinLength(true)
            )

Events(System.Action)

Configures the client-side events.

Parameters

clientEventsAction - System.Action<MultiSelectEventBuilder>

The client events action.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Events(events =>
                            events.Change("change")
                        )
            )

Filter(System.String)

Enables the filtering of items.

Parameters

filter - System.String

The type of filtering.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Filter("startswith");
            )

Filter(Kendo.Mvc.UI.FilterType)

Enables the filtering of items.

Parameters

filter - FilterType

The type of filtering.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Filter(FilterType.Contains);
            )

Items(System.Action)

Defines the items in the MultiSelect

Parameters

addAction - System.Action<DropDownListItemFactory>

The add action.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Items(items =>
                        {
                            items.Add().Text("First Item");
                            items.Add().Text("Second Item");
                        })
            )

HighlightFirst(System.Boolean)

Use it to enable highlighting of first matched item.

Parameters

highlightFirst - System.Boolean

If true, enables the highlighting.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .HighlightFirst(true)
            )

Messages(System.Action)

The text messages displayed in the component. Use it to customize or localize the messages.

Parameters

configurator - System.Action<MultiSelectMessagesSettingsBuilder>

The action that configures the messages.

MaxSelectedItems(System.Int32)

Specifies the limit of the selected items. If set to null the component will not limit the number of the selected items.

Parameters

maxItems - System.Int32

The max number of selected items.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .MaxSelectedItems(3)
            )

MinLength(System.Int32)

Specifies the minimum number of characters that should be typed before the component queries the dataSource.

Parameters

length - System.Int32

The number of characters.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .MinLength(3)
            )

Placeholder(System.String)

A string that appears in the textbox when it has no value.

Parameters

placeholder - System.String

The text that appears as placeholder.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Placeholder("Select country...")
            )

ItemTemplate(System.String)

Template to be used for rendering the items in the list.

Parameters

template - System.String

The content to be rendered in the items.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .ItemTemplate("#= data #")
            )

ItemTemplateId(System.String)

Specifies the id of the template to be used for rendering the items in the list.

Parameters

templateId - System.String

The id of the template.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .ItemTemplateId("widgetTemplateId")
            )

TagMode(Kendo.Mvc.UI.TagMode)

The mode used to render the selected tags. The available modes are 'single' and 'multiple'

Parameters

mode - TagMode

The tag mode.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .TagMode(TagMode.Single)
            )

TagTemplate(System.String)

Template to be used for rendering the tags of the selected items.

Parameters

template - System.String

The content to be rendered in the tags.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .TagTemplate("#= data #")
            )

TagTemplateId(System.String)

Specifies the id of the tag template for the selected items.

Parameters

templateId - System.String

The id of the template.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .TagTemplateId("widgetTemplateId")
            )

Value(System.Collections.IEnumerable)

Sets the value of the component.

Parameters

value - System.Collections.IEnumerable

The collection of values.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Value(new string[] { "1" })
            )

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size.

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Size(ComponentSize.Medium)
            )

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .Rounded(Rounded.Medium)
            )

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

Example


             @(Html.Kendo().MultiSelect()
                        .Name("MultiSelect")
                        .FillMode(FillMode.Solid)
            )

Animation(System.Boolean)

Use to enable or disable animation of the popup element.

Parameters

enable - System.Boolean

The boolean value.

Example


            @( Html.Kendo().DropDownList()
                       .Name("DropDownList")
                       .Animation(false) //toggle effect
            )

Animation(System.Action)

Configures the animation effects of the widget.

Parameters

animationAction - System.Action<PopupAnimationBuilder>

The action which configures the animation effects.

Example


            @( Html.Kendo().DropDownList()
                       .Name("DropDownList")
                       .Animation(animation =>
                       {
                            animation.Open(open =>
                            {
                                open.SlideIn(SlideDirection.Down);
                            });
                       })
            )

BindTo(System.Collections.IEnumerable)

Binds the widget to an IEnumerable list.

Parameters

data - System.Collections.IEnumerable

The data source.

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .DataTextField("CompanyName")
                        .DataValueField("CompanyID")
                        .BindTo(new List<Company>
                        {
                            new Company {
                                CompanyName = "Text1",
                                CompanyID = "Value1"
                            },
                            new Company {
                                CompanyName = "Text2",
                                CompanyID = "Value2"
                            } })
            )

DataTextField(System.String)

Sets the field of the data item that provides the text content of the list items.

Parameters

field - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .DataTextField("Text")
            )

DataSource(System.Action)

Configures the DataSource options.

Parameters

configurator - System.Action<ReadOnlyDataSourceBuilder>

The DataSource configurator action.

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .DataSource(source =>
                        {
                            source.Read(read =>
                            {
                                read.Action("GetProducts", "Home");
                            });
                        })
            )

DataSource(System.String)

Parameters

dataSourceId - System.String

Delay(System.Int32)

Specifies the delay in ms after which the widget will start filtering the dataSource.

Parameters

delay - System.Int32

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Delay(300)
            )

Enable(System.Boolean)

Enables or disables the combobox.

Parameters

value - System.Boolean

FixedGroupTemplate(System.String)

Fixed group template which will be rendered as a static group header of the popup element.

Parameters

fixedGroupTemplate - System.String

FixedGroupTemplateId(System.String)

FixedGroupTemplateId to be used for rendering the static header of the popup element.

Parameters

fixedGroupTemplateId - System.String

GroupTemplate(System.String)

Group template which will be rendered as a group header of each new group in the popup.

Parameters

groupTemplate - System.String

GroupTemplateId(System.String)

GroupTemplateId to be used for rendering the static header of the popup element.

Parameters

groupTemplateId - System.String

IgnoreCase(System.Boolean)

Use it to enable case insensitive bahavior of the combobox. If true the combobox will select the first matching item ignoring its casing.

Parameters

ignoreCase - System.Boolean

Example


             @( Html.Kendo().ComboBox()
                        .Name("ComboBox")
                        .IgnoreCase(true)
            )

Height(System.Int32)

Sets the height of the drop-down list in pixels.

Parameters

height - System.Int32

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Height(300)
            )

HeaderTemplate(System.String)

Header template which will be rendered as a static header of the popup element.

Parameters

headerTemplate - System.String

Example

 ")
            )

HeaderTemplateId(System.String)

HeaderTemplateId to be used for rendering the static header of the popup element.

Parameters

headerTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .HeaderTemplateId("widgetHeaderTemplateId")
            )

FooterTemplate(System.String)

Footer template which will be rendered as a static footer of the popup element.

Parameters

footerTemplate - System.String

Example

  items found")
            )

FooterTemplateId(System.String)

FooterTemplateId to be used for rendering the static footer of the popup element.

Parameters

footerTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .FooterTemplateId("widgetFooterTemplateId")
            )

NoDataTemplate(System.String)

No data template which will be rendered as a static no-data template of the popup element.

Parameters

noDataTemplate - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .NoDataTemplate("No Data!")
            )

NoDataTemplateId(System.String)

NoDataTemplateId to be used for rendering the static no-data template of the popup element.

Parameters

noDataTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .NoDataTemplateId("widgetNoDataTemplateId")
            )

Popup(System.Action)

Configures the popup settings of the widget.

Parameters

popupAction - System.Action<PopupSettingsBuilder>

ValuePrimitive(System.Boolean)

Parameters

valuePrimitive - System.Boolean

Virtual(System.Boolean)

Configures the virtualization settings of the widget.

Parameters

enable - System.Boolean

Virtual(System.Action)

Configures the virtualization settings of the widget.

Parameters

virtualizationAction - System.Action<VirtualSettingsBuilder>

Label(System.Action)

Adds a label before the input. If the input has no id attribute, a generated id will be assigned. The string and the function parameters are setting the inner HTML of the label.

Parameters

configurator - System.Action<LabelSettingsBuilder>

ToComponent()

Returns the internal view component.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name of the component.

Example


            @(Html.Kendo().Grid<OrderViewModel>()
               .Name("grid")
               .Columns(columns =>
               {
                   columns.Bound(p => p.OrderID).Filterable(false);
                   columns.Bound(p => p.Freight);  
               })
               .DataSource(dataSource => dataSource
                   .Ajax()
                   .PageSize(20)
                   .Read(read => read.Action("Orders_Read", "Grid"))
               )
            )

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean)

Parameters

deferred - System.Boolean

ModelMetadata(System.Web.Mvc.ModelMetadata)

Uses the Metadata of the Model.

Parameters

modelMetadata - System.Web.Mvc.ModelMetadata

The metadata set for the Model

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

Render()

Renders the component.

Example


            @(@Page Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" )
            @( Html.Kendo().Grid(Model)
                .Name("grid")
                .DetailTemplate(product => {
                    )
                       Product Details:
                       <div>Product Name: @( product.ProductName )</div>
                       <div>Units In Stock: @( product.UnitsInStock )</div>
                    @(
                })
                .Render();
            )

ToHtmlString()

ToClientTemplate()

In this article
Not finding the help you need?