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

DropDownListBuilder

Defines the fluent interface for configuring the DropDownList component.

Methods

AutoBind(System.Boolean)

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

Parameters

autoBind - System.Boolean

Example


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

AutoWidth(System.Boolean)

Controls whether to adjust the popup width

Parameters

autoWidth - System.Boolean

Example


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

BindTo(System.Collections.Generic.IEnumerable)

Binds the DropDownList to a list of DropDownListItem.

Parameters

dataSource - System.Collections.Generic.IEnumerable<DropDownListItem>

The data source.

Example


             @(Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .BindTo(new List <DropDownListItem>
                        {
                            new DropDownListItem() {
                                Text = "Text1",
                                Value = "Value1"
                            },
                            new DropDownListItem() {
                                Text = "Text2",
                                Value = "Value2"
                            } })
            )

BindTo(System.Collections.Generic.IEnumerable)

Binds the DropDownList to a list of DropDownListItem.

Parameters

dataSource - System.Collections.Generic.IEnumerable<SelectListItem>

The data source.

Example


             @(Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .BindTo(new List <DropDownListItem>
                        {
                            new DropDownListItem() {
                                Text = "Text1",
                                Value = "Value1"
                            },
                            new DropDownListItem() {
                                Text = "Text2",
                                Value = "Value2"
                            } })
            )

DataValueField(System.String)

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

Parameters

field - System.String

Example


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

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

enforceMinLength - System.Boolean

Example


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

Events(System.Action)

Configures the client-side events.

Parameters

clientEventsAction - System.Action<DropDownListEventBuilder>

The client events action.

Example


             @(Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Events(events =>
                            events.Change("change")
                        )
             )

Filter(System.String)

Use it to enable filtering of items.

Parameters

filter - System.String

Example


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

Filter(Kendo.Mvc.UI.FilterType)

Use it to enable filtering of items.

Parameters

filter - FilterType

Example


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

Items(System.Action)

Defines the items in the DropDownList

Parameters

addAction - System.Action<DropDownListItemFactory>

The add action.

Example


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

Messages(System.Action)

Parameters

configurator - System.Action<DropDownListMessagesSettingsBuilder>

OptionLabel(System.String)

Define the text of the default empty item.

Parameters

optionLabel - System.String

Example


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

OptionLabel(System.Object)

Define the object of the default empty item.

Parameters

optionLabel - System.Object

Example


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

MinLength(System.Int32)

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

Parameters

length - System.Int32

Example


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

SelectedIndex(System.Int32)

Use it to set selected item index

Parameters

index - System.Int32

Item index.

Example


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

CascadeFrom(System.String)

Use it to set the Id of the parent DropDownList.

Parameters

cascadeFrom - System.String

Example


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

CascadeFromField(System.String)

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

Parameters

cascadeFromField - System.String

Example


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

CascadeFromParentField(System.String)

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

Parameters

cascadeFromParentField - System.String

Example


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

Text(System.String)

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

Parameters

text - System.String

Example


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

Text(System.Object)

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

Parameters

text - System.Object

OptionLabelTemplate(System.String)

OptionLabelTemplate to be used to render the option label content.

Parameters

optionLabelTemplate - System.String

Example


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

OptionLabelTemplateId(System.String)

OptionLabelTemplateId to be used to render the option label content.

Parameters

optionLabelTemplateId - System.String

Example


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

ValueTemplate(System.String)

ValueTemplate to be used to render the selected value.

Parameters

valueTemplate - System.String

Example


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

ValueTemplateId(System.String)

ValueTemplateId to be used to render the selected value.

Parameters

valueTemplateId - System.String

Example


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

FilterTitle(System.String)

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

Parameters

value - System.String

The value for FilterTitle

Example


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

Size(Kendo.Mvc.UI.ComponentSize)

Sets the size of the component.

Parameters

value - ComponentSize

The value for Size

Example


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

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

Example


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

             )

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

Example


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

Template(System.String)

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

Parameters

template - System.String

Example


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

TemplateId(System.String)

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

Parameters

templateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .TemplateId("widgetTemplateId")
            )

Value(System.String)

Sets the value of the widget.

Parameters

value - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Value("1")
            )

Animation(System.Boolean)

Use to enable or disable animation of the popup element.

Parameters

enable - System.Boolean

The boolean value.

Example


            @( Html.Kendo().DropDownList()
                       .Name("DropDownList")
                       .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.

Example


            @( Html.Kendo().DropDownList()
                       .Name("DropDownList")
                       .Animation(animation =>
                       {
                            animation.Open(open =>
                            {
                                open.SlideIn(SlideDirection.Down);
                            });
                       })
            )

BindTo(System.Collections.IEnumerable)

Binds the widget to an IEnumerable list.

Parameters

data - System.Collections.IEnumerable

The data source.

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .DataTextField("CompanyName")
                        .DataValueField("CompanyID")
                        .BindTo(new List<Company>
                        {
                            new Company {
                                CompanyName = "Text1",
                                CompanyID = "Value1"
                            },
                            new Company {
                                CompanyName = "Text2",
                                CompanyID = "Value2"
                            } })
            )

DataTextField(System.String)

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

Parameters

field - System.String

Example


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

DataSource(System.Action)

Configures the DataSource options.

Parameters

configurator - System.Action<ReadOnlyDataSourceBuilder>

The DataSource configurator action.

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .DataSource(source =>
                        {
                            source.Read(read =>
                            {
                                read.Action("GetProducts", "Home");
                            });
                        })
            )

DataSource(System.String)

Parameters

dataSourceId - System.String

Delay(System.Int32)

Specifies the delay in ms after which the widget will start filtering the dataSource.

Parameters

delay - System.Int32

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Delay(300)
            )

Enable(System.Boolean)

Enables or disables the combobox.

Parameters

value - System.Boolean

FixedGroupTemplate(System.String)

Fixed group template which will be rendered as a static group header of the popup element.

Parameters

fixedGroupTemplate - System.String

FixedGroupTemplateId(System.String)

FixedGroupTemplateId to be used for rendering the static header of the popup element.

Parameters

fixedGroupTemplateId - System.String

GroupTemplate(System.String)

Group template which will be rendered as a group header of each new group in the popup.

Parameters

groupTemplate - System.String

GroupTemplateId(System.String)

GroupTemplateId to be used for rendering the static header of the popup element.

Parameters

groupTemplateId - System.String

IgnoreCase(System.Boolean)

Use it to enable case insensitive bahavior of the combobox. If true the combobox will select the first matching item ignoring its casing.

Parameters

ignoreCase - System.Boolean

Example


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

Height(System.Int32)

Sets the height of the drop-down list in pixels.

Parameters

height - System.Int32

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .Height(300)
            )

HeaderTemplate(System.String)

Header template which will be rendered as a static header of the popup element.

Parameters

headerTemplate - System.String

Example

 ")
            )

HeaderTemplateId(System.String)

HeaderTemplateId to be used for rendering the static header of the popup element.

Parameters

headerTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .HeaderTemplateId("widgetHeaderTemplateId")
            )

FooterTemplate(System.String)

Footer template which will be rendered as a static footer of the popup element.

Parameters

footerTemplate - System.String

Example

  items found")
            )

FooterTemplateId(System.String)

FooterTemplateId to be used for rendering the static footer of the popup element.

Parameters

footerTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .FooterTemplateId("widgetFooterTemplateId")
            )

NoDataTemplate(System.String)

No data template which will be rendered as a static no-data template of the popup element.

Parameters

noDataTemplate - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .NoDataTemplate("No Data!")
            )

NoDataTemplateId(System.String)

NoDataTemplateId to be used for rendering the static no-data template of the popup element.

Parameters

noDataTemplateId - System.String

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .NoDataTemplateId("widgetNoDataTemplateId")
            )

Popup(System.Action)

Configures the popup settings of the widget.

Parameters

popupAction - System.Action<PopupSettingsBuilder>

ValuePrimitive(System.Boolean)

Parameters

valuePrimitive - System.Boolean

Virtual(System.Boolean)

Configures the virtualization settings of the widget.

Parameters

enable - System.Boolean

Virtual(System.Action)

Configures the virtualization settings of the widget.

Parameters

virtualizationAction - System.Action<VirtualSettingsBuilder>

ToComponent()

Returns the internal view component.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name of the component.

Example


            @(Html.Kendo().Grid<OrderViewModel>()
               .Name("grid")
               .Columns(columns =>
               {
                   columns.Bound(p => p.OrderID).Filterable(false);
                   columns.Bound(p => p.Freight);  
               })
               .DataSource(dataSource => dataSource
                   .Ajax()
                   .PageSize(20)
                   .Read(read => read.Action("Orders_Read", "Grid"))
               )
            )

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean)

Parameters

deferred - System.Boolean

ModelMetadata(System.Web.Mvc.ModelMetadata)

Uses the Metadata of the Model.

Parameters

modelMetadata - System.Web.Mvc.ModelMetadata

The metadata set for the Model

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

HtmlAttributes(System.Collections.Generic.IDictionary)

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

Render()

Renders the component.

Example


            @(@Page Inherits="System.Web.Mvc.ViewPage<IEnumerable<Product>>" )
            @( Html.Kendo().Grid(Model)
                .Name("grid")
                .DetailTemplate(product => {
                    )
                       Product Details:
                       <div>Product Name: @( product.ProductName )</div>
                       <div>Units In Stock: @( product.UnitsInStock )</div>
                    @(
                })
                .Render();
            )

ToHtmlString()

ToClientTemplate()

In this article
Not finding the help you need?