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

ListBuilderBase

Methods

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

FixedGroupTemplateView(System.Web.Mvc.MvcHtmlString)

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

Parameters

fixedGroupTemplateView - System.Web.Mvc.MvcHtmlString

FixedGroupTemplateHandler(System.String)

The JavaScript handler that returns the fixed group template which will be rendered as a static group header of the popup element.

Parameters

value - System.String

FixedGroupTemplate(Kendo.Mvc.UI.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the fixed group template.

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

GroupTemplateView(System.Web.Mvc.MvcHtmlString)

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

Parameters

groupTemplateView - System.Web.Mvc.MvcHtmlString

GroupTemplateHandler(System.String)

The JavaScript ghandler that returns the Group template which will be rendered as a group header of each new group in the popup.

Parameters

value - System.String

GroupTemplate(Kendo.Mvc.UI.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the fixed group template.

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")
            )

HeaderTemplateView(System.Web.Mvc.MvcHtmlString)

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

Parameters

headerTemplateView - System.Web.Mvc.MvcHtmlString

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .HeaderTemplateView(Html.Partial("HeaderTemplate"))
            )

HeaderTemplateHandler(System.String)

The JAvaScript function that returns the Header template which will be rendered as a static header of the popup element.

Parameters

value - System.String

HeaderTemplate(Kendo.Mvc.UI.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the fixed group template.

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")
            )

FooterTemplateView(System.Web.Mvc.MvcHtmlString)

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

Parameters

footerTemplateView - System.Web.Mvc.MvcHtmlString

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .FooterTemplateView(Html.Partial("FooterTemplate"))
            )

FooterTemplateHandler(System.String)

The JavaScript function that returns the Footer template which will be rendered as a static footer of the popup element.

Parameters

value - System.String

FooterTemplate(Kendo.Mvc.UI.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the fixed group template.

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")
            )

NoDataTemplateView(System.Web.Mvc.MvcHtmlString)

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

Parameters

noDataTemplateView - System.Web.Mvc.MvcHtmlString

Example


             @( Html.Kendo().DropDownList()
                        .Name("DropDownList")
                        .NoDataTemplateView(Html.Partial("NoDataTemplate"))
            )

NoDataTemplateHandler(System.String)

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

Parameters

value - System.String

NoDataTemplate(Kendo.Mvc.UI.TemplateBuilder)

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

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the fixed group template.

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>

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<LabelSettingsBuilder>

AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)

Parameters

value - AdaptiveMode

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

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>

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

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();
            )

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.

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.

ToHtmlString()

ToClientTemplate()

In this article
Not finding the help you need?