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

MultiSelectBuilder

Class

Defines the fluent interface for configuring the MultiSelect component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class MultiSelectBuilder : ListBuilderBase<MultiSelect, MultiSelectBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<MultiSelect, MultiSelectBuilder>ListBuilderBase<MultiSelect, MultiSelectBuilder>MultiSelectBuilder

Implements: IHtmlString

Constructors

MultiSelectBuilder(MultiSelect)

Initializes a new instance of the MultiSelectBuilder class.

public MultiSelectBuilder(MultiSelect component)

Parameters:componentMultiSelect

The component.

Methods

AutoBind(bool)

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

public MultiSelectBuilder AutoBind(bool autoBind)

Parameters:autoBindbool

If true, enables binding on initialization.

Returns:

MultiSelectBuilder

Example:

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

AutoClose(bool)

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

public MultiSelectBuilder AutoClose(bool autoClose)

Parameters:autoClosebool

If true, enables suggestion list auto-close.

Returns:

MultiSelectBuilder

Example:

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

AutoWidth(bool)

Controls whether to adjust the popup width

public MultiSelectBuilder AutoWidth(bool autoWidth)

Parameters:autoWidthbool

If true, enables automatic popup width adjustment.

Returns:

MultiSelectBuilder

Example:

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

BindTo(IEnumerable<DropDownListItem>)

Binds the MultiSelect to a list of DropDownListItem.

public MultiSelectBuilder BindTo(IEnumerable<DropDownListItem> dataSource)

Parameters:dataSourceIEnumerable<DropDownListItem>

The data source.

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.BindTo(new List&lt;DropDownListItem&gt;
{
new DropDownListItem{
Text = "Text1",
Value = "Value1"
},
new DropDownListItem{
Text = "Text2",
Value = "Value2"
} })
)

BindTo(IEnumerable<SelectListItem>)

Binds the MultiSelect to a list of SelectListItem.

public MultiSelectBuilder BindTo(IEnumerable<SelectListItem> dataSource)

Parameters:dataSourceIEnumerable<SelectListItem>

The data source.

Returns:

MultiSelectBuilder

Example:

@( Html.Kendo().MultiSelect()
.Name("MultiSelect")
.BindTo(new List&lt;SelectListItem&gt;
{
new SelectListItem{
Text = "Text1",
Value = "Value1"
},
new SelectListItem{
Text = "Text2",
Value = "Value2"
} })
)

Checkboxes(bool)

When set to true, renders a checkbox next to each item in the dropdown list.

public MultiSelectBuilder Checkboxes(bool value)

Parameters:valuebool

The value for Checkboxes

Returns:

MultiSelectBuilder

ClearButton(bool)

Use to enable or disable clear button functionality.

public MultiSelectBuilder ClearButton(bool enable)

Parameters:enablebool

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

Returns:

MultiSelectBuilder

Example:

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

DataValueField(string)

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

public MultiSelectBuilder DataValueField(string field)

Parameters:fieldstring

The name of the field.

Returns:

MultiSelectBuilder

Example:

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

DownArrow()

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

public MultiSelectBuilder DownArrow()

Returns:

MultiSelectBuilder

Example:

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

DownArrow(bool)

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

public MultiSelectBuilder DownArrow(bool value)

Parameters:valuebool

If true, a down arrow is rendered.

Returns:

MultiSelectBuilder

Example:

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

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.

public MultiSelectBuilder EnforceMinLength(bool enforceMinLength)

Parameters:enforceMinLengthbool

The boolean value.

Returns:

MultiSelectBuilder

Example:

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

Events(Action<MultiSelectEventBuilder>)

Configures the client-side events.

public MultiSelectBuilder Events(Action<MultiSelectEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<MultiSelectEventBuilder>

The client events action.

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.Events(events =&gt;
events.Change("change")
)
)

FillMode(FillMode)

Sets a value controlling how the color is applied.

public MultiSelectBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode

Returns:

MultiSelectBuilder

Example:

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

Filter(FilterType)

Enables the filtering of items.

public MultiSelectBuilder Filter(FilterType filter)

Parameters:filterFilterType

The type of filtering.

Returns:

MultiSelectBuilder

Example:

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

Filter(string)

Enables the filtering of items.

public MultiSelectBuilder Filter(string filter)

Parameters:filterstring

The type of filtering.

Returns:

MultiSelectBuilder

Example:

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

HighlightFirst(bool)

Use it to enable highlighting of first matched item.

public MultiSelectBuilder HighlightFirst(bool highlightFirst)

Parameters:highlightFirstbool

If true, enables the highlighting.

Returns:

MultiSelectBuilder

Example:

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

InputMode(string)

Defines the "inputmode" attribute of the inner <input /> element. The attribute specifies the type of on-screen keyboard displayed when the user focuses the input.

public MultiSelectBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("multiSelect")
.InputMode("search")
)

Items(Action<DropDownListItemFactory>)

Defines the items in the MultiSelect

public MultiSelectBuilder Items(Action<DropDownListItemFactory> addAction)

Parameters:addActionAction<DropDownListItemFactory>

The add action.

Returns:

MultiSelectBuilder

Example:

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

ItemTemplate(string)

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

public MultiSelectBuilder ItemTemplate(string template)

Parameters:templatestring

The content to be rendered in the items.

Returns:

MultiSelectBuilder

Example:

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

ItemTemplateHandler(string)

Sets the name of the JavaScript function that will be used as the item template handler for the MultiSelect.

public MultiSelectBuilder ItemTemplateHandler(string template)

Parameters:templatestring

The name of the JavaScript function that will handle the item template.

Returns:

MultiSelectBuilder

ItemTemplateId(string)

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

public MultiSelectBuilder ItemTemplateId(string templateId)

Parameters:templateIdstring

The id of the template.

Returns:

MultiSelectBuilder

Example:

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

ItemTemplateView(MvcHtmlString)

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

public MultiSelectBuilder ItemTemplateView(MvcHtmlString template)

Parameters:templateMvcHtmlString

The view which contains template.

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.ItemTemplateView(Html.Partial("widgetTemplate"))
)

MaxSelectedItems(int)

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

public MultiSelectBuilder MaxSelectedItems(int maxItems)

Parameters:maxItemsint

The max number of selected items.

Returns:

MultiSelectBuilder

Example:

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

Messages(Action<MultiSelectMessagesSettingsBuilder>)

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

public MultiSelectBuilder Messages(Action<MultiSelectMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<MultiSelectMessagesSettingsBuilder>

The action that configures the messages.

Returns:

MultiSelectBuilder

MinLength(int)

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

public MultiSelectBuilder MinLength(int length)

Parameters:lengthint

The number of characters.

Returns:

MultiSelectBuilder

Example:

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

Placeholder(string)

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

public MultiSelectBuilder Placeholder(string placeholder)

Parameters:placeholderstring

The text that appears as placeholder.

Returns:

MultiSelectBuilder

Example:

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

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

The configuration for the prefix adornment of the widget.

public MultiSelectBuilder PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

MultiSelectBuilder

Readonly(bool)

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly be default and allow user input.

public MultiSelectBuilder Readonly(bool value)

Parameters:valuebool

The value for Readonly

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.Readonly(true);
)

Rounded(Rounded?)

Sets a value controlling the border radius.

public MultiSelectBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded

Returns:

MultiSelectBuilder

Example:

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

SelectAll()

When set to true, renders a sticky "Select all" header at the top of the dropdown list.

public MultiSelectBuilder SelectAll()

Returns:

MultiSelectBuilder

SelectAll(bool)

When set to true, renders a sticky "Select all" header at the top of the dropdown list.

public MultiSelectBuilder SelectAll(bool value)

Parameters:valuebool

The value for SelectAll

Returns:

MultiSelectBuilder

Size(ComponentSize?)

Sets the size of the component.

public MultiSelectBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size.

Returns:

MultiSelectBuilder

Example:

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

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

The configuration for the suffix adornment of the widget.

public MultiSelectBuilder SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

MultiSelectBuilder

SummarizeAfter(double)

When set to a number, the tag list switches to a summarized display once the number of selected items exceeds this value.

public MultiSelectBuilder SummarizeAfter(double value)

Parameters:valuedouble

The value for SummarizeAfter

Returns:

MultiSelectBuilder

TagMode(TagMode)

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

public MultiSelectBuilder TagMode(TagMode mode)

Parameters:modeTagMode

The tag mode.

Returns:

MultiSelectBuilder

Example:

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

TagTemplate(string)

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

public MultiSelectBuilder TagTemplate(string template)

Parameters:templatestring

The content to be rendered in the tags.

Returns:

MultiSelectBuilder

Example:

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

TagTemplateHandler(string)

Sets the name of the JavaScript function that will be used as the tag template handler for the MultiSelect.

public MultiSelectBuilder TagTemplateHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will handle the tag template.

Returns:

MultiSelectBuilder

TagTemplateId(string)

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

public MultiSelectBuilder TagTemplateId(string templateId)

Parameters:templateIdstring

The id of the template.

Returns:

MultiSelectBuilder

Example:

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

TagTemplateView(MvcHtmlString)

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

public MultiSelectBuilder TagTemplateView(MvcHtmlString template)

Parameters:templateMvcHtmlString

The view which contains the template.

Returns:

MultiSelectBuilder

Example:

@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.TagTemplateView(Html.Partial("widgetTemplate"))
)

Value(IEnumerable)

Sets the value of the component.

public MultiSelectBuilder Value(IEnumerable value)

Parameters:valueIEnumerable

The collection of values.

Returns:

MultiSelectBuilder

Example:

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