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

MultiColumnComboBoxBuilder

Class

Defines the fluent interface for configuring the MultiColumnComboBox component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class MultiColumnComboBoxBuilder : DropDownListBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>ListBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>DropDownListBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>MultiColumnComboBoxBuilder

Implements: IHtmlString

Constructors

MultiColumnComboBoxBuilder(MultiColumnComboBox)

Initializes a new instance of the ComboBoxBuilder class.

public MultiColumnComboBoxBuilder(MultiColumnComboBox component)

Parameters:componentMultiColumnComboBox

The component.

Methods

AutoBind(bool)

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

public MultiColumnComboBoxBuilder AutoBind(bool autoBind)

Parameters:autoBindbool

The value that enables or disables the automatic data binding.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.AutoBind(false)
)

BindTo(IEnumerable<DropDownListItem>)

Binds the MultiColumnComboBox to an IEnumerable collection of DropDownListItem.

public MultiColumnComboBoxBuilder BindTo(IEnumerable<DropDownListItem> dataSource)

Parameters:dataSourceIEnumerable<DropDownListItem>

The data collection.

Returns:

MultiColumnComboBoxBuilder

Example:

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

BindTo(IEnumerable<SelectListItem>)

Binds the MultiColumnComboBox to an IEnumerable collection of SelectListItem.

public MultiColumnComboBoxBuilder BindTo(IEnumerable<SelectListItem> dataSource)

Parameters:dataSourceIEnumerable<SelectListItem>

The data collection.

Returns:

MultiColumnComboBoxBuilder

Example:

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

CascadeFrom(string)

Defines the Name() of the parent MultiColumnComboBox .

public MultiColumnComboBoxBuilder CascadeFrom(string cascadeFrom)

Parameters:cascadeFromstring

The value that configures the name of the parent component.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("parentMultiColumnComboBox")
)
@(Html.Kendo().MultiColumnComboBox()
.Name("childMultiColumnComboBox")
.CascadeFrom("parentMultiColumnComboBox")
)

CascadeFromField(string)

Defines the field that will be used to filter the DataSource. If it is not defined, the parent's DataValueField option will be used.

public MultiColumnComboBoxBuilder CascadeFromField(string cascadeFromField)

Parameters:cascadeFromFieldstring

The value that configures the field.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("parentMultiColumnComboBox")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
)
@(Html.Kendo().MultiColumnComboBox()
.Name("childMultiColumnComboBox")
.DataTextField("ProductName")
.DataValueField("ProductID")
.CascadeFrom("parentMultiColumnComboBox")
.CascadeFromField("ParentID")
)

CascadeFromParentField(string)

Defines the parent field that will be used to retain value from. This value will be used further to filter the DataSource. If it is not defined, the value from the parent's DataValueField will be used.

public MultiColumnComboBoxBuilder CascadeFromParentField(string cascadeFromParentField)

Parameters:cascadeFromParentFieldstring

The value that configures the field.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("parentMultiColumnComboBox")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
)
@(Html.Kendo().MultiColumnComboBox()
.Name("childMultiColumnComboBox")
.DataTextField("ProductName")
.DataValueField("ProductID")
.CascadeFrom("parentMultiColumnComboBox")
.CascadeFromField("ParentID")
.CascadeFromParentField("CascadeID")
)

CascadeOnCustomValue()

The option applies to a parent MultiColumnComboBox in a cascading scenario. If the option is added, the cascading will be triggered upon custom input in the parent component. Cascade on custom values works only when the CascadeFromParentField is not set for the child MultiColumnComboBox, or it points to the DataValueField of the parent.

public MultiColumnComboBoxBuilder CascadeOnCustomValue()

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("parentMultiColumnComboBox")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
.CascadeOnCustomValue()
)
@(Html.Kendo().MultiColumnComboBox()
.Name("childMultiColumnComboBox")
.DataTextField("ProductName")
.DataValueField("ProductID")
.CascadeFrom("parentMultiColumnComboBox")
.CascadeFromField("ParentID")
)

CascadeOnCustomValue(bool)

The option applies to a parent MultiColumnComboBox in a cascading scenario. If enabled, the cascading will be triggered upon custom input in the parent component. When set to "false" (default), the child will not cascade and it will be disabled upon setting custom input in the parent MultiColumnComboBox. Cascade on custom values works only when the CascadeFromParentField is not set for the child MultiColumnComboBox, or it points to the DataValueField of the parent.

public MultiColumnComboBoxBuilder CascadeOnCustomValue(bool value)

Parameters:valuebool

The value that enables or disables the option.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("parentMultiColumnComboBox")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
.CascadeOnCustomValue(true)
)
@(Html.Kendo().MultiColumnComboBox()
.Name("childMultiColumnComboBox")
.DataTextField("ProductName")
.DataValueField("ProductID")
.CascadeFrom("parentMultiColumnComboBox")
.CascadeFromField("ParentID")
)

ClearButton(bool)

If the option is enabled, a button will appear when hovering the MultiColumnComboBox. Clicking that button will reset the component's value and trigger the Change event.

public MultiColumnComboBoxBuilder ClearButton(bool enable)

Parameters:enablebool

The value that toggles the visibility of the clear button.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.ClearButton(true)
)

Columns(Action<MultiColumnComboBoxColumnFactory>)

Defines the columns rendered in the table of the MultiColumnComboBox.

public MultiColumnComboBoxBuilder Columns(Action<MultiColumnComboBoxColumnFactory> configurator)

Parameters:configuratorAction<MultiColumnComboBoxColumnFactory>

The action that configures the column settings.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Columns(columns =&gt;
{
columns.Add().Field("ProductName").Title("Name");
columns.Add().Field("ProductID").Title("ID");
})
)

DataValueField(string)

Sets the field of the data item that provides the value of the MultiColumnComboBox.

public MultiColumnComboBoxBuilder DataValueField(string field)

Parameters:fieldstring

The value that configures the value field.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
)

DropDownWidth(int)

Sets the width of the dropdown. The numeric values are treated as pixels.

public MultiColumnComboBoxBuilder DropDownWidth(int value)

Parameters:valueint

The value that configures the width.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.DropDownWidth(600)
)

DropDownWidth(string)

Sets the width of the dropdown.

public MultiColumnComboBoxBuilder DropDownWidth(string value)

Parameters:valuestring

The value that configures the width.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.DropDownWidth("600")
)

EnforceMinLength(bool)

When this option is enabled, the component will not show all items when the text of the search input is cleared. By default, the MultiColumnComboBox shows all items when the text of the search input is cleared. Works in conjunction with the MinLength() option.

public MultiColumnComboBoxBuilder EnforceMinLength(bool enforceMinLength)

Parameters:enforceMinLengthbool

The value that enables the option.

Returns:

MultiColumnComboBoxBuilder

Example:

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

Events(Action<MultiColumnComboBoxEventBuilder>)

Configures the handled client-side events of the MultiColumnComboBox.

public MultiColumnComboBoxBuilder Events(Action<MultiColumnComboBoxEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<MultiColumnComboBoxEventBuilder>

The action that configures the available events.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Events(events =&gt;
events.Change("onChange")
)
)

FillMode(FillMode)

Sets a value that controls how the color is applied to the component.

public MultiColumnComboBoxBuilder FillMode(FillMode value)

Parameters:valueFillMode

The enum value that configures the fill mode.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.FillMode(FillMode.Solid)
)

Filter(FilterType)

Defines the filtering method used to determine the suggestions for the current value. The filtering can be performed over string values only (either the component's data has to be an array of strings, or over the specified DataTextField() field.

public MultiColumnComboBoxBuilder Filter(FilterType filter)

Parameters:filterFilterType

The enum value that configures the filter operator.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Filter(FilterType.Contains)
)

Filter(string)

public MultiColumnComboBoxBuilder Filter(string filter)

Parameters:filterstring

The value that configures the filter operator.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Filter("startswith")
)

FilterFields(string[])

Defines the fields for filtering the MultiColumnComboBox.

public MultiColumnComboBoxBuilder FilterFields(string[] fields)

Parameters:fieldsstring[]

The value that configures the collection of fields.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.FilterFields(new string[] {"Country", "City"})
.Filter("contains")
.DataTextField("Name")
.DataValueField("ID")
)

HighlightFirst(bool)

When the option is enabled, the first suggestion will be automatically highlighted.

public MultiColumnComboBoxBuilder HighlightFirst(bool highlightFirst)

Parameters:highlightFirstbool

The value that enables or disables the option.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.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 MultiColumnComboBoxBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.InputMode("search")
)

Items(Action<DropDownListItemFactory>)

Defines the items in the MultiColumnComboBox.

public MultiColumnComboBoxBuilder Items(Action<DropDownListItemFactory> addAction)

Parameters:addActionAction<DropDownListItemFactory>

The action that configures the items.

Returns:

MultiColumnComboBoxBuilder

Example:

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

Messages(Action<MessagesSettingsBuilder>)

Defines the localization of the texts that are used in the MultiColumnComboBox.

public MultiColumnComboBoxBuilder Messages(Action<MessagesSettingsBuilder> configurator)

Parameters:configuratorAction<MessagesSettingsBuilder>

The action that configures the messages.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Messages(msg =&gt; msg.Clear("Clear!").NoData("There is no data!"))
)

MinLength(int)

Specifies the minimum number of characters the user must type before a search is performed.

public MultiColumnComboBoxBuilder MinLength(int length)

Parameters:lengthint

The value that configures the minimum number of characters.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.MinLength(3)
)

Placeholder(string)

Defines the hint displayed by the MultiColumnComboBox when it is empty.

public MultiColumnComboBoxBuilder Placeholder(string placeholder)

Parameters:placeholderstring

The value that configures the placeholder.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Placeholder("Select country...")
)

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

Defines the configuration for the prefix adornment of the component.

public MultiColumnComboBoxBuilder PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.PrefixOptions(prefix =&gt; prefix.Icon("map-marker-target"))
)

Rounded(Rounded?)

Sets the border radius of the component.

public MultiColumnComboBoxBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The enum value that configures the border radius.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Rounded(Rounded.Medium)
)

SelectedIndex(int)

Defines index of the initially selected item.

public MultiColumnComboBoxBuilder SelectedIndex(int index)

Parameters:indexint

The value that configures the index.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.SelectedIndex(0)
)

Size(ComponentSize?)

Sets the size of the component.

public MultiColumnComboBoxBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The enum value that configures the size.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Size(ComponentSize.Large)
)

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

Defines the configuration for the suffix adornment of the component.

public MultiColumnComboBoxBuilder SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.SuffixOptions(suffix =&gt; suffix.Icon("search"))
)

Suggest(bool)

Controls whether the MultiColumnComboBox must automatically use the first suggestion as its value.

public MultiColumnComboBoxBuilder Suggest(bool suggest)

Parameters:suggestbool

The value that enables or disables the option.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Suggest(true)
)

SyncValueAndText(bool)

Controls whether the MultiColumnComboBox must automatically set the selected value to the typed custom text. Disable the option to clear the selected value but keep the custom text.

public MultiColumnComboBoxBuilder SyncValueAndText(bool syncValueAndText)

Parameters:syncValueAndTextbool

The value that enables or disables the option.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.SyncValueAndText(false)
)

Template(string)

This method is not valid for MultiColumnComboBox - use Template() option within the Columns() configuration instead.

public override MultiColumnComboBoxBuilder Template(string template)

Parameters:templatestringReturns:

MultiColumnComboBoxBuilder

Overrides: DropDownListBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>.Template(string)

TemplateId(string)

This method is not valid for MultiColumnComboBox - use TemplateId() option within the Columns() configuration instead.

public override MultiColumnComboBoxBuilder TemplateId(string templateId)

Parameters:templateIdstringReturns:

MultiColumnComboBoxBuilder

Overrides: DropDownListBuilderBase<MultiColumnComboBox, MultiColumnComboBoxBuilder>.TemplateId(string)

Text(string)

Define the text of the MultiColumnComboBox used when the AutoBind option is disabled.

public MultiColumnComboBoxBuilder Text(string text)

Parameters:textstring

The value that configures the initial option text.

Returns:

MultiColumnComboBoxBuilder

Example:

@(Html.Kendo().MultiColumnComboBox()
.Name("multiColumnComboBox")
.Text("Chai")
.AutoBind(false)
)