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

ComboBoxBuilder

Class

Defines the fluent interface for configuring the ComboBox component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ComboBoxBuilder : DropDownListBuilderBase<ComboBox, ComboBoxBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<ComboBox, ComboBoxBuilder>ListBuilderBase<ComboBox, ComboBoxBuilder>DropDownListBuilderBase<ComboBox, ComboBoxBuilder>ComboBoxBuilder

Implements: IHtmlString

Constructors

ComboBoxBuilder(ComboBox)

Initializes a new instance of the ComboBoxBuilder class.

public ComboBoxBuilder(ComboBox component)

Parameters:componentComboBox

The component.

Methods

AutoBind(bool)

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

public ComboBoxBuilder AutoBind(bool autoBind)

Parameters:autoBindboolReturns:

ComboBoxBuilder

Example:

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

AutoWidth(bool)

Controls whether to adjust the popup width

public ComboBoxBuilder AutoWidth(bool autoWidth)

Parameters:autoWidthboolReturns:

ComboBoxBuilder

Example:

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

BindTo(IEnumerable<DropDownListItem>)

Binds the ComboBox to a list of DropDownListItem.

public ComboBoxBuilder BindTo(IEnumerable<DropDownListItem> dataSource)

Parameters:dataSourceIEnumerable<DropDownListItem>

The data source.

Returns:

ComboBoxBuilder

Example:

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

BindTo(IEnumerable<SelectListItem>)

Binds the ComboBox to a list of SelectListItem.

public ComboBoxBuilder BindTo(IEnumerable<SelectListItem> dataSource)

Parameters:dataSourceIEnumerable<SelectListItem>

The data source.

Returns:

ComboBoxBuilder

Example:

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

CascadeFrom(string)

Specifies the Id of the parent ComboBox, from which the child will cascade.

public ComboBoxBuilder CascadeFrom(string cascadeFrom)

Parameters:cascadeFromstring

The Id of the parent ComboBox.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox2")
.CascadeFrom("ComboBox1")
)

CascadeFromField(string)

Sets the field used to filter the data source.

public ComboBoxBuilder CascadeFromField(string cascadeFromField)

Parameters:cascadeFromFieldstring

The name of the field.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox2")
.CascadeFrom("ComboBox1")
.CascadeFromField("ParentID")
)

CascadeFromParentField(string)

Defines the parent field to be used to retain value from. This value will be used further to filter the data source.

public ComboBoxBuilder CascadeFromParentField(string cascadeFromParentField)

Parameters:cascadeFromParentFieldstring

The name of the field.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox2")
.CascadeFrom("ComboBox1")
.CascadeFromField("ParentID")
.CascadeFromParentField("ParentID")
)

Applicable to a parent ComboBox in a cascading scenario. If set to true 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 ComboBox. Cascade on custom values works only when cascadeFromParentField is not set for the child combo, or it points to the dataValueField of the parent.

public ComboBoxBuilder CascadeOnCustomValue()

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox2")
.CascadeFrom("ComboBox1")
.CascadeOnCustomValue()
)

CascadeOnCustomValue(bool)

public ComboBoxBuilder CascadeOnCustomValue(bool value)

Parameters:valuebool

If true, enables cascading from a custom value.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox2")
.CascadeFrom("ComboBox1")
.CascadeOnCustomValue(true)
)

ClearButton(bool)

Use to enable or disable clear button functionality.

public ComboBoxBuilder ClearButton(bool enable)

Parameters:enablebool

The boolean value.

Returns:

ComboBoxBuilder

Example:

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

DataValueField(string)

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

public ComboBoxBuilder DataValueField(string field)

Parameters:fieldstring

The name of the field.

Returns:

ComboBoxBuilder

Example:

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

EnforceMinLength(bool)

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 ComboBoxBuilder EnforceMinLength(bool enforceMinLength)

Parameters:enforceMinLengthbool

The boolean value.

Returns:

ComboBoxBuilder

Example:

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

Events(Action<ComboBoxEventBuilder>)

Configures the client-side events.

public ComboBoxBuilder Events(Action<ComboBoxEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<ComboBoxEventBuilder>

The client events action.

Returns:

ComboBoxBuilder

Example:

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

FillMode(FillMode)

Sets a value controlling how the color is applied.

public ComboBoxBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode.

Returns:

ComboBoxBuilder

Example:

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

Filter(FilterType)

Enables the filtering of items.

public ComboBoxBuilder Filter(FilterType filter)

Parameters:filterFilterType

The type of filtering.

Returns:

ComboBoxBuilder

Example:

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

Filter(string)

Enables the filtering of items.

public ComboBoxBuilder Filter(string filter)

Parameters:filterstring

The type of filtering.

Returns:

ComboBoxBuilder

Example:

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

HighlightFirst(bool)

Use it to enable or disable the highlighting of the first matched item.

public ComboBoxBuilder HighlightFirst(bool highlightFirst)

Parameters:highlightFirstbool

If true, enables the highlighting.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox")
.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 ComboBoxBuilder InputMode(string value)

Parameters:valuestring

The value that configures the "inputmode" attribute.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("comboBox")
.InputMode("search")
)

Items(Action<DropDownListItemFactory>)

Defines the items in the ComboBox

public ComboBoxBuilder Items(Action<DropDownListItemFactory> addAction)

Parameters:addActionAction<DropDownListItemFactory>

The add action.

Returns:

ComboBoxBuilder

Example:

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

Messages(Action<MessagesSettingsBuilder>)

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

public ComboBoxBuilder Messages(Action<MessagesSettingsBuilder> configurator)

Parameters:configuratorAction<MessagesSettingsBuilder>

The action that configures the messages.

Returns:

ComboBoxBuilder

MinLength(int)

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

public ComboBoxBuilder MinLength(int length)

Parameters:lengthint

The number of characters.

Returns:

ComboBoxBuilder

Example:

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

Placeholder(string)

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

public ComboBoxBuilder Placeholder(string placeholder)

Parameters:placeholderstring

The text that will appear as placeholder.

Returns:

ComboBoxBuilder

Example:

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

PrefixOptions(Action<PrefixOptionsSettingsBuilder>)

The configuration for the prefix adornment of the widget.

public ComboBoxBuilder PrefixOptions(Action<PrefixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<PrefixOptionsSettingsBuilder>

The action that configures the prefix options.

Returns:

ComboBoxBuilder

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 ComboBoxBuilder Readonly(bool value)

Parameters:valuebool

The value for Readonly

Returns:

ComboBoxBuilder

Example:

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

Rounded(Rounded?)

Sets a value controlling the border radius.

public ComboBoxBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded.

Returns:

ComboBoxBuilder

Example:

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

SelectedIndex(int)

Sets the index of the item that will be selected.

public ComboBoxBuilder SelectedIndex(int index)

Parameters:indexint

The index of the item.

Returns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox")
.SelectedIndex(0);
)

Size(ComponentSize?)

Sets the size of the component.

public ComboBoxBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size.

Returns:

ComboBoxBuilder

Example:

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

SuffixOptions(Action<SuffixOptionsSettingsBuilder>)

The configuration for the suffix adornment of the widget.

public ComboBoxBuilder SuffixOptions(Action<SuffixOptionsSettingsBuilder> configurator)

Parameters:configuratorAction<SuffixOptionsSettingsBuilder>

The action that configures the suffix options.

Returns:

ComboBoxBuilder

Suggest(bool)

Controls whether the ComboBox should automatically auto-type the rest of text.

public ComboBoxBuilder Suggest(bool suggest)

Parameters:suggestbool

If true, enables auto-type.

Returns:

ComboBoxBuilder

Example:

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

SyncValueAndText(bool)

Controls whether the ComboBox should automatically sync custom text with the selected value.

public ComboBoxBuilder SyncValueAndText(bool syncValueAndText)

Parameters:syncValueAndTextboolReturns:

ComboBoxBuilder

Example:

@(Html.Kendo().ComboBox()
.Name("ComboBox")
.SyncValueAndText(false)
)

Text(string)

Define the text of the component, when AutoBind is set to false.

public ComboBoxBuilder Text(string text)

Parameters:textstring

The text to be shown in the input.

Returns:

ComboBoxBuilder

Example:

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