MultiSelectBuilder
Properties
WriteAction - Func
Methods
Animation(System.Boolean)
Use to enable or disable animation of the popup element.
Parameters
enable - System.Boolean
The boolean value.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( Html.Kendo().MultiSelect()
.Name("MultiSelect")
.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.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( 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
data - System.Collections.IEnumerable
The data source.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( 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)
Binds the MultiSelect to a list of SelectListItem.
Parameters
dataSource - System.Collections.Generic.IEnumerable<SelectListItem>
The data source.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( Html.Kendo().MultiSelect()
.Name("MultiSelect")
.BindTo(new List<SelectListItem>
{
new SelectListItem{
Text = "Text1",
Value = "Value1"
},
new SelectListItem{
Text = "Text2",
Value = "Value2"
}
}))
Items(System.Action)
Defines the items in the MultiSelect
Parameters
addAction - System.Action<SelectListItemFactory>
The add action.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( Html.Kendo().MultiSelect()
.Name("MultiSelect")
.Items(items =>
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
}))
DataSource(System.Action)
Sets the data source configuration of the MultiSelect.
Parameters
configurator - System.Action<ReadOnlyDataSourceBuilder>
The lambda which configures the data source
DataSource(System.String)
Parameters
dataSourceId - System.String
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.
Parameters
value - System.Collections.IEnumerable
The collection of values.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@( Html.Kendo().MultiSelect()
.Name("MultiSelect")
.Value(new string[] { "1" }))
AdaptiveTitle(System.String)
Allows customization of the title's text in the adaptive view of the component.
Parameters
value - System.String
The value for AdaptiveTitle
RETURNS
Returns the current MultiSelectBuilder instance.
AdaptiveSubtitle(System.String)
Allows customization of the subtitle's text in the adaptive view of the component.
Parameters
value - System.String
The value for AdaptiveSubtitle
RETURNS
Returns the current MultiSelectBuilder instance.
AutoBind(System.Boolean)
Controls whether to bind the widget to the data source on initialization.
Parameters
value - System.Boolean
The value for AutoBind
RETURNS
Returns the current MultiSelectBuilder instance.
AutoClose(System.Boolean)
Controls whether to close the widget suggestion list on item selection.
Parameters
value - System.Boolean
The value for AutoClose
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
DataValueField(System.String)
The field of the data item that provides the value of the widget.
Parameters
value - System.String
The value for DataValueField
RETURNS
Returns the current MultiSelectBuilder instance.
Delay(System.Double)
Specifies the delay in milliseconds after which the MultiSelect will start filtering dataSource.
Parameters
value - System.Double
The value for Delay
RETURNS
Returns the current MultiSelectBuilder instance.
DownArrow(System.Boolean)
Configures MultiSelect to render a down arrow that opens and closes its popup.
Parameters
value - System.Boolean
The value for DownArrow
RETURNS
Returns the current MultiSelectBuilder instance.
DownArrow()
Configures MultiSelect to render a down arrow that opens and closes its popup.
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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.
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
FixedGroupTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for FixedGroupTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
FixedGroupTemplateHandler(System.String)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
templateHandler - System.String
The handler that returs the template for FixedGroupTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
FixedGroupTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template used to render the fixed header group. By default the widget displays only the value of the current group.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the fixedgrouptemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
FooterTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for FooterTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
FooterTemplateHandler(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
templateHandler - System.String
The handler that returs the template for FooterTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
FooterTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the footertemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
InputMode(System.String)
Specifies the inputmode attribute of the inner <input /> element. It is used to specify the type of on-screen keyboard that should be displayed when the user focuses the input.
Parameters
value - System.String
The value for InputMode
RETURNS
Returns the current MultiSelectBuilder instance.
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<MultiSelectLabelSettingsBuilder>
The configurator for the label setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
GroupTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for GroupTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
GroupTemplateHandler(System.String)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
templateHandler - System.String
The handler that returs the template for GroupTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
GroupTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template used to render the groups. By default the widget displays only the value of the group.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the grouptemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
HighlightFirst(System.Boolean)
If set to true the first suggestion will be automatically highlighted.
Parameters
value - System.Boolean
The value for HighlightFirst
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
Messages(System.Action)
The text messages displayed in the widget. Use this option to customize or localize the messages.
Parameters
configurator - System.Action<MultiSelectMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
NoDataTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
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
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for NoDataTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
NoDataTemplateHandler(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
templateHandler - System.String
The handler that returs the template for NoDataTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
NoDataTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
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
template - TemplateBuilder<TModel>
A Template component that configures the nodatatemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
Popup(System.Action)
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<MultiSelectPopupSettingsBuilder>
The configurator for the popup setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
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
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
HeaderTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for HeaderTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
HeaderTemplateHandler(System.String)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
templateHandler - System.String
The handler that returs the template for HeaderTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
HeaderTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
Specifies a static HTML content, which will be rendered as a header of the popup element.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the headertemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
ItemTemplate(System.String)
The template used to render the items in the popup list.
Parameters
value - System.String
The value for ItemTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
ItemTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the items in the popup list.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for ItemTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
ItemTemplateHandler(System.String)
The template used to render the items in the popup list.
Parameters
templateHandler - System.String
The handler that returs the template for ItemTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
ItemTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template used to render the items in the popup list.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the itemtemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
PrefixOptions(System.Action)
The configuration for the prefix adornment of the component.
Parameters
configurator - System.Action<MultiSelectPrefixOptionsSettingsBuilder>
The configurator for the prefixoptions setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
SuffixOptions(System.Action)
The configuration for the suffix adornment of the component.
Parameters
configurator - System.Action<MultiSelectSuffixOptionsSettingsBuilder>
The configurator for the suffixoptions setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
TagTemplate(System.String)
The template used to render the tags.
Parameters
value - System.String
The value for TagTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
TagTemplateId(System.String)
The template used to render the tags.
Parameters
templateId - System.String
The ID of the template element for TagTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
TagTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template used to render the tags.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for TagTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
TagTemplateHandler(System.String)
The template used to render the tags.
Parameters
templateHandler - System.String
The handler that returs the template for TagTemplate
RETURNS
Returns the current MultiSelectBuilder instance.
TagTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template used to render the tags.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the tagtemplate.
RETURNS
Returns the current MultiSelectBuilder instance.
TagMode(Kendo.Mvc.UI.MultiSelectTagMode)
Represents available tag modes of MultiSelect.
Parameters
value - MultiSelectTagMode
The value for TagMode
RETURNS
Returns the current MultiSelectBuilder instance.
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
RETURNS
Returns the current MultiSelectBuilder instance.
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.
RETURNS
Returns the current MultiSelectBuilder instance.
Virtual(System.Action)
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<MultiSelectVirtualSettingsBuilder>
The configurator for the virtual setting.
RETURNS
Returns the current instance of MultiSelectBuilder .
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.
RETURNS
Returns the current instance of MultiSelectBuilder .
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.
RETURNS
Returns the current instance of MultiSelectVirtualSettingsBuilder .
Readonly(System.Boolean)
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.
Parameters
value - System.Boolean
The value for Readonly
Filter(Kendo.Mvc.UI.FilterType)
The filtering method used to determine the suggestions for the current value.
Parameters
value - FilterType
The value for Filter
RETURNS
Returns the current MultiSelectBuilder instance.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current MultiSelectBuilder instance.
Rounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the border radius.
Parameters
value - Rounded
The value for Rounded
RETURNS
Returns the current MultiSelectBuilder instance.
FillMode(Kendo.Mvc.UI.FillMode)
Sets a value controlling how the color is applied.
Parameters
value - FillMode
The value for FillMode
RETURNS
Returns the current MultiSelectBuilder instance.
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)
Specifies the adaptive rendering of the component.
Parameters
value - AdaptiveMode
The value for AdaptiveMode
RETURNS
Returns the current MultiSelectBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<MultiSelectEventBuilder>
The client events action.
RETURNS
Returns the current MultiSelectBuilder instance.
Example
@(Html.Kendo().MultiSelect()
.Name("MultiSelect")
.Events(events => events
.Change("onChange")
)
)
UseMvvmInitialization(System.Boolean)
Specifies if the component should be initialized through MVVM on the client.
Parameters
value - System.Boolean
The value.
RETURNS
Returns the current instance.
UseMvvmInitialization()
Specifies if the component should be initialized through MVVM on the client.
RETURNS
Returns the current instance.
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.