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

DropDownListBuilder

Class

Defines the fluent interface for configuring the DropDownList component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class DropDownListBuilder : DropDownListBuilderBase<DropDownList, DropDownListBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<DropDownList, DropDownListBuilder>ListBuilderBase<DropDownList, DropDownListBuilder>DropDownListBuilderBase<DropDownList, DropDownListBuilder>DropDownListBuilder

Implements: IHtmlString

Methods

AutoBind(bool)

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

public DropDownListBuilder AutoBind(bool autoBind)

Parameters:autoBindboolReturns:

DropDownListBuilder

Example:

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

AutoWidth(bool)

Controls whether to adjust the popup width

public DropDownListBuilder AutoWidth(bool autoWidth)

Parameters:autoWidthboolReturns:

DropDownListBuilder

Example:

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

BindTo(IEnumerable<DropDownListItem>)

Binds the DropDownList to a list of DropDownListItem.

public DropDownListBuilder BindTo(IEnumerable<DropDownListItem> dataSource)

Parameters:dataSourceIEnumerable<DropDownListItem>

The data source.

Returns:

DropDownListBuilder

Example:

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

BindTo(IEnumerable<SelectListItem>)

Binds the DropDownList to a list of SelectListItem.

public DropDownListBuilder BindTo(IEnumerable<SelectListItem> dataSource)

Parameters:dataSourceIEnumerable<SelectListItem>

The data source.

Returns:

DropDownListBuilder

Example:

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

CascadeFrom(string)

Use it to set the Id of the parent DropDownList.

public DropDownListBuilder CascadeFrom(string cascadeFrom)

Parameters:cascadeFromstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList2")
.CascadeFrom("DropDownList1")
)

CascadeFromField(string)

Use it to set the field used to filter the data source.

public DropDownListBuilder CascadeFromField(string cascadeFromField)

Parameters:cascadeFromFieldstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList2")
.CascadeFrom("DropDownList1")
.CascadeFromField("ParentID")
)

CascadeFromParentField(string)

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

public DropDownListBuilder CascadeFromParentField(string cascadeFromParentField)

Parameters:cascadeFromParentFieldstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList2")
.CascadeFrom("DropDownList1")
.CascadeFromField("ParentID")
.CascadeFromParentField("ParentID")
)

DataValueField(string)

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

public DropDownListBuilder DataValueField(string field)

Parameters:fieldstringReturns:

DropDownListBuilder

Example:

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

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.

public DropDownListBuilder EnforceMinLength(bool enforceMinLength)

Parameters:enforceMinLengthboolReturns:

DropDownListBuilder

Example:

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

Events(Action<DropDownListEventBuilder>)

Configures the client-side events.

public DropDownListBuilder Events(Action<DropDownListEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<DropDownListEventBuilder>

The client events action.

Returns:

DropDownListBuilder

Example:

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

FillMode(FillMode)

Sets a value controlling how the color is applied.

public DropDownListBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode

Returns:

DropDownListBuilder

Example:

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

Filter(FilterType)

Use it to enable filtering of items.

public DropDownListBuilder Filter(FilterType filter)

Parameters:filterFilterTypeReturns:

DropDownListBuilder

Example:

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

Filter(string)

Use it to enable filtering of items.

public DropDownListBuilder Filter(string filter)

Parameters:filterstringReturns:

DropDownListBuilder

Example:

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

FilterTitle(string)

When filtering is enabled, allows custom title to be defined for the filter input element.

public DropDownListBuilder FilterTitle(string value)

Parameters:valuestring

The value for FilterTitle

Returns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.FilterTitle("MyFilter")
)

Items(Action<DropDownListItemFactory>)

Defines the items in the DropDownList

public DropDownListBuilder Items(Action<DropDownListItemFactory> addAction)

Parameters:addActionAction<DropDownListItemFactory>

The add action.

Returns:

DropDownListBuilder

Example:

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

Messages(Action<DropDownListMessagesSettingsBuilder>)

public DropDownListBuilder Messages(Action<DropDownListMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<DropDownListMessagesSettingsBuilder>Returns:

DropDownListBuilder

MinLength(int)

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

public DropDownListBuilder MinLength(int length)

Parameters:lengthintReturns:

DropDownListBuilder

Example:

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

OptionLabel(object)

Define the object of the default empty item.

public DropDownListBuilder OptionLabel(object optionLabel)

Parameters:optionLabelobjectReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.DataTextField("Text")
.DataValueField("Value")
.OptionLabel(new { Text = "Text1", Value = "Value1" })
)

OptionLabel(string)

Define the text of the default empty item.

public DropDownListBuilder OptionLabel(string optionLabel)

Parameters:optionLabelstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.OptionLabel("Select country...")
)

OptionLabelTemplate(string)

OptionLabelTemplate to be used to render the option label content.

public DropDownListBuilder OptionLabelTemplate(string optionLabelTemplate)

Parameters:optionLabelTemplatestringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.OptionLabelTemplate("#= data #")
)

OptionLabelTemplate<TModel>(TemplateBuilder<TModel>)

OptionLabelTemplateView to be used to render the option label content.

public DropDownListBuilder OptionLabelTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

DropDownListBuilder

OptionLabelTemplateHandler(string)

public DropDownListBuilder OptionLabelTemplateHandler(string value)

Parameters:valuestringReturns:

DropDownListBuilder

OptionLabelTemplateId(string)

OptionLabelTemplateId to be used to render the option label content.

public DropDownListBuilder OptionLabelTemplateId(string optionLabelTemplateId)

Parameters:optionLabelTemplateIdstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.OptionLabelTemplateId("widgetOptionLabelTemplateId")
)

OptionLabelTemplateView(MvcHtmlString)

OptionLabelTemplateView to be used to render the option label content.

public DropDownListBuilder OptionLabelTemplateView(MvcHtmlString optionLabelTemplateView)

Parameters:optionLabelTemplateViewMvcHtmlStringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.OptionLabelTemplateView(Html.Partial("OptionLabelTemplate"))
)

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

Parameters:valuebool

The value for Readonly

Returns:

DropDownListBuilder

Example:

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

Rounded(Rounded?)

Sets a value controlling the border radius.

public DropDownListBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded

Returns:

DropDownListBuilder

Example:

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

)

SelectedIndex(int)

Use it to set selected item index

public DropDownListBuilder SelectedIndex(int index)

Parameters:indexint

Item index.

Returns:

DropDownListBuilder

Example:

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

Size(ComponentSize?)

Sets the size of the component.

public DropDownListBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size

Returns:

DropDownListBuilder

Example:

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

Text(object)

Define the default item of the widget when the autoBind option is set to false.

public DropDownListBuilder Text(object text)

Parameters:textobjectReturns:

DropDownListBuilder

Text(string)

Define the text of the widget, when the autoBind is set to false.

public DropDownListBuilder Text(string text)

Parameters:textstringReturns:

DropDownListBuilder

Example:

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

ValueTemplate(string)

ValueTemplate to be used to render the selected value.

public DropDownListBuilder ValueTemplate(string valueTemplate)

Parameters:valueTemplatestringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.ValueTemplate("#= data #")
)

ValueTemplate<TModel>(TemplateBuilder<TModel>)

ValueTemplateView to be used to render the selected value.

public DropDownListBuilder ValueTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

DropDownListBuilder

ValueTemplateHandler(string)

The name of the JavaScript function that will return the template to be used to render the selected value.

public DropDownListBuilder ValueTemplateHandler(string value)

Parameters:valuestringReturns:

DropDownListBuilder

ValueTemplateId(string)

ValueTemplateId to be used to render the selected value.

public DropDownListBuilder ValueTemplateId(string valueTemplateId)

Parameters:valueTemplateIdstringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.ValueTemplateId("widgetValueTemplateId")
)

ValueTemplateView(MvcHtmlString)

ValueTemplateView to be used to render the selected value.

public DropDownListBuilder ValueTemplateView(MvcHtmlString valueTemplateView)

Parameters:valueTemplateViewMvcHtmlStringReturns:

DropDownListBuilder

Example:

@(Html.Kendo().DropDownList()
.Name("DropDownList")
.ValueTemplateView(Html.Partial("ValueTemplate"))
)

DropDownListBuilder

Definition

Constructors