Kendo.Mvc.UI.Fluent.MultiSelectBuilder

Defines the fluent API for configuring the Kendo UI MultiSelect

Methods

Animation(System.Boolean)

Use to enable or disable animation of the popup element.

Parameters

enable System.Boolean

The boolean value.

Example (ASPX)

<%= Html.Kendo().MultiSelect()
    .Name("MultiSelect")
    .Animation(false) //toggle effect
%>

Animation(System.Action<Kendo.Mvc.UI.Fluent.PopupAnimationBuilder>)

Configures the animation effects of the widget.

Parameters

animationAction System.Action<Kendo.Mvc.UI.Fluent.PopupAnimationBuilder>

The action which configures the animation effects.

Example (ASPX)

<%= Html.Kendo().MultiSelect()
    .Name("MultiSelect")
    .Animation(animation =>
    {
        animation.Open(open =>
        {
            open.SlideIn(SlideDirection.Down);
        })
    })
%>

BindTo(System.Collections.IEnumerable)

Binds the MultiSelect to an IEnumerable list.

Parameters

dataSource System.Collections.IEnumerable

The data source.

Example (ASPX)

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

BindTo(System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem>)

Binds the MultiSelect to a list of SelectListItem.

Parameters

dataSource System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem>

The data source.

Example (ASPX)

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

Items(System.Action<Kendo.Mvc.UI.Fluent.SelectListItemFactory>)

Defines the items in the MultiSelect

Parameters

addAction System.Action<Kendo.Mvc.UI.Fluent.SelectListItemFactory>

The add action.

Example (ASPX)

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

DataSource(System.Action<Kendo.Mvc.UI.Fluent.ReadOnlyDataSourceBuilder>)

Sets the data source configuration of the MultiSelect.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.ReadOnlyDataSourceBuilder>

The lambda which configures the data source

Filter(System.String)

Use it to enable filtering of items. The supported filter values are startswith, endswith and contains.

Parameters

value System.String

The value for Filter

Value(System.Collections.IEnumerable)

Sets the value of the widget.

Example (ASPX)

<%= Html.Kendo().MultiSelect()
    .Name("MultiSelect")
    .Value(new string[] { "1" })
%>

AutoBind(System.Boolean)

Controls whether to bind the widget to the data source on initialization.

Parameters

value System.Boolean

The value for AutoBind

AutoClose(System.Boolean)

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

Parameters

value System.Boolean

The value for AutoClose

AutoWidth(System.Boolean)

If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.

Parameters

value System.Boolean

The value for AutoWidth

ClearButton(System.Boolean)

Unless this options is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.

Parameters

value System.Boolean

The value for ClearButton

DataTextField(System.String)

The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.

Parameters

value System.String

The value for DataTextField

DataValueField(System.String)

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

Parameters

value System.String

The value for DataValueField

Delay(System.Double)

Specifies the delay in milliseconds after which the MultiSelect will start filtering dataSource.

Parameters

value System.Double

The value for Delay

DownArrow(System.Boolean)

Configures MultiSelect to render a down arrow that opens and closes its popup.

Parameters

value System.Boolean

The value for DownArrow

DownArrow

Configures MultiSelect to render a down arrow that opens and closes its popup.

Enable(System.Boolean)

If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.

Parameters

value System.Boolean

The value for Enable

EnforceMinLength(System.Boolean)

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

Parameters

value System.Boolean

The value for EnforceMinLength

EnforceMinLength

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

FixedGroupTemplate(System.String)

The template used to render the fixed header group. By default the widget displays only the value of the current group.

Parameters

value System.String

The value for FixedGroupTemplate

FixedGroupTemplateId(System.String)

The template used to render the fixed header group. By default the widget displays only the value of the current group.

Parameters

templateId System.String

The ID of the template element for FixedGroupTemplate

FooterTemplate(System.String)

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

Parameters

value System.String

The value for FooterTemplate

FooterTemplateId(System.String)

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

Parameters

templateId System.String

The ID of the template element for FooterTemplate

GroupTemplate(System.String)

The template used to render the groups. By default the widget displays only the value of the group.

Parameters

value System.String

The value for GroupTemplate

GroupTemplateId(System.String)

The template used to render the groups. By default the widget displays only the value of the group.

Parameters

templateId System.String

The ID of the template element for GroupTemplate

Height(System.Double)

The height of the suggestion popup in pixels. The default value is 200 pixels.

Parameters

value System.Double

The value for Height

HighlightFirst(System.Boolean)

If set to true the first suggestion will be automatically highlighted.

Parameters

value System.Boolean

The value for HighlightFirst

IgnoreCase(System.Boolean)

If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.

Parameters

value System.Boolean

The value for IgnoreCase

Messages(System.Action<Kendo.Mvc.UI.Fluent.MultiSelectMessagesSettingsBuilder>)

The text messages displayed in the widget. Use this option to customize or localize the messages.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.MultiSelectMessagesSettingsBuilder>

The configurator for the messages setting.

MinLength(System.Double)

The minimum number of characters the user must type before a search is performed. Set to a higher value if the search could match a lot of items. A zero value means that a request will be made as soon as the user focuses the widget.

Parameters

value System.Double

The value for MinLength

MaxSelectedItems(System.Double)

Defines the limit of the selected items. If set to null widget will not limit number of the selected items.

Parameters

value System.Double

The value for MaxSelectedItems

NoDataTemplate(System.String)

The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.

Parameters

value System.String

The value for NoDataTemplate

NoDataTemplateId(System.String)

The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.

Parameters

templateId System.String

The ID of the template element for NoDataTemplate

Placeholder(System.String)

The hint displayed by the widget when it is empty. Not set by default.

Parameters

value System.String

The value for Placeholder

Popup(System.Action<Kendo.Mvc.UI.Fluent.MultiSelectPopupSettingsBuilder>)

The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.MultiSelectPopupSettingsBuilder>

The configurator for the popup setting.

HeaderTemplate(System.String)

Specifies a static HTML content, which will be rendered as a header of the popup element.

Parameters

value System.String

The value for HeaderTemplate

HeaderTemplateId(System.String)

Specifies a static HTML content, which will be rendered as a header of the popup element.

Parameters

templateId System.String

The ID of the template element for HeaderTemplate

ItemTemplate(System.String)

The template used to render the items in the popup list.

Parameters

value System.String

The value for ItemTemplate

ItemTemplateId(System.String)

The template used to render the items in the popup list.

Parameters

templateId System.String

The ID of the template element for ItemTemplate

TagTemplate(System.String)

The template used to render the tags.

Parameters

value System.String

The value for TagTemplate

TagTemplateId(System.String)

The template used to render the tags.

Parameters

templateId System.String

The ID of the template element for TagTemplate

TagMode(Kendo.Mvc.UI.MultiSelectTagMode)

Represents available tag modes of MultiSelect.

Parameters

value Kendo.Mvc.UI.MultiSelectTagMode

The value for TagMode

ValuePrimitive(System.Boolean)

Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.

Parameters

value System.Boolean

The value for ValuePrimitive

ValuePrimitive

Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.

Virtual(System.Action<Kendo.Mvc.UI.Fluent.MultiSelectVirtualSettingsBuilder>)

Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.MultiSelectVirtualSettingsBuilder>

The configurator for the virtual setting.

Virtual

Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.

Virtual(System.Boolean)

Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.

Parameters

enabled System.Boolean

Enables or disables the virtual option.

Filter(Kendo.Mvc.UI.FilterType)

The filtering method used to determine the suggestions for the current value.

Parameters

value Kendo.Mvc.UI.FilterType

The value for Filter

Events(System.Action<Kendo.Mvc.UI.Fluent.MultiSelectEventBuilder>)

Configures the client-side events.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.MultiSelectEventBuilder>

The client events action.

Example (ASPX)

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