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

ListBuilderBase<TDropDown, TDropDownBuilder>

Class

Defines the fluent interface for configuring the DropDownList, ComboBox and MultiSelect components.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TDropDown

TDropDownBuilder

Syntax:

public class ListBuilderBase<TDropDown, TDropDownBuilder> : WidgetBuilderBase<TDropDown, TDropDownBuilder>, IHtmlString where TDropDown : ListBase where TDropDownBuilder : WidgetBuilderBase<TDropDown, TDropDownBuilder>

Inheritance: objectWidgetBuilderBase<TDropDown, TDropDownBuilder>ListBuilderBase<TDropDown, TDropDownBuilder>

Derived Classes: DropDownListBuilderBase<TDropDown, TDropDownBuilder>MultiSelectBuilder

Implements: IHtmlString

Constructors

ListBuilderBase(TDropDown)

public ListBuilderBase(TDropDown component)

Parameters:componentTDropDown

Methods

AdaptiveMode(AdaptiveMode)

Specifies the adaptive rendering of the component.

public TDropDownBuilder AdaptiveMode(AdaptiveMode value)

Parameters:valueAdaptiveMode

The value for AdaptiveMode.

Returns:

TDropDownBuilder

AdaptiveSubtitle(string)

Allows customization of the subtitle's text in the adaptive view of the component.

public TDropDownBuilder AdaptiveSubtitle(string value)

Parameters:valuestring

The value that configures the adaptivesubtitle.

Returns:

TDropDownBuilder

AdaptiveTitle(string)

Allows customization of the title's text in the adaptive view of the component.

public TDropDownBuilder AdaptiveTitle(string value)

Parameters:valuestring

The value that configures the adaptivetitle.

Returns:

TDropDownBuilder

Animation(Action<PopupAnimationBuilder>)

Configures the animation effects of the widget.

public TDropDownBuilder Animation(Action<PopupAnimationBuilder> animationAction)

Parameters:animationActionAction<PopupAnimationBuilder>

The action which configures the animation effects.

Returns:

TDropDownBuilder

Example:

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

Animation(bool)

Use to enable or disable animation of the popup element.

public TDropDownBuilder Animation(bool enable)

Parameters:enablebool

The boolean value.

Returns:

TDropDownBuilder

Example:

@( Html.Kendo().DropDownList()
.Name("DropDownList")
.Animation(false) //toggle effect
)

BindTo(IEnumerable)

Binds the widget to an IEnumerable list.

public TDropDownBuilder BindTo(IEnumerable data)

Parameters:dataIEnumerable

The data source.

Returns:

TDropDownBuilder

Example:

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

DataSource(Action<ReadOnlyDataSourceBuilder>)

Configures the DataSource options.

public TDropDownBuilder DataSource(Action<ReadOnlyDataSourceBuilder> configurator)

Parameters:configuratorAction<ReadOnlyDataSourceBuilder>

The DataSource configurator action.

Returns:

TDropDownBuilder

Example:

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

DataSource(string)

Sets the id of the external data source for the widget.

public TDropDownBuilder DataSource(string dataSourceId)

Parameters:dataSourceIdstringReturns:

TDropDownBuilder

DataTextField(string)

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

public TDropDownBuilder DataTextField(string field)

Parameters:fieldstringReturns:

TDropDownBuilder

Example:

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

Delay(int)

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

public TDropDownBuilder Delay(int delay)

Parameters:delayintReturns:

TDropDownBuilder

Example:

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

Enable(bool)

Enables or disables the combobox.

public TDropDownBuilder Enable(bool value)

Parameters:valueboolReturns:

TDropDownBuilder

FixedGroupTemplate(string)

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

public TDropDownBuilder FixedGroupTemplate(string fixedGroupTemplate)

Parameters:fixedGroupTemplatestringReturns:

TDropDownBuilder

FixedGroupTemplate<TModel>(TemplateBuilder<TModel>)

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

public TDropDownBuilder FixedGroupTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the fixed group template.

Returns:

TDropDownBuilder

FixedGroupTemplateHandler(string)

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

public TDropDownBuilder FixedGroupTemplateHandler(string value)

Parameters:valuestringReturns:

TDropDownBuilder

FixedGroupTemplateId(string)

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

public TDropDownBuilder FixedGroupTemplateId(string fixedGroupTemplateId)

Parameters:fixedGroupTemplateIdstringReturns:

TDropDownBuilder

FixedGroupTemplateView(MvcHtmlString)

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

public TDropDownBuilder FixedGroupTemplateView(MvcHtmlString fixedGroupTemplateView)

Parameters:fixedGroupTemplateViewMvcHtmlStringReturns:

TDropDownBuilder

FooterTemplate(string)

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

public TDropDownBuilder FooterTemplate(string footerTemplate)

Parameters:footerTemplatestringReturns:

TDropDownBuilder

Example:

@( Html.Kendo().DropDownList()
.Name("DropDownList")
.FooterTemplate("Total #: instance.dataSource.total() # items found")
)

FooterTemplate<TModel>(TemplateBuilder<TModel>)

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

public TDropDownBuilder FooterTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the fixed group template.

Returns:

TDropDownBuilder

FooterTemplateHandler(string)

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

public TDropDownBuilder FooterTemplateHandler(string value)

Parameters:valuestringReturns:

TDropDownBuilder

FooterTemplateId(string)

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

public TDropDownBuilder FooterTemplateId(string footerTemplateId)

Parameters:footerTemplateIdstringReturns:

TDropDownBuilder

Example:

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

FooterTemplateView(MvcHtmlString)

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

public TDropDownBuilder FooterTemplateView(MvcHtmlString footerTemplateView)

Parameters:footerTemplateViewMvcHtmlStringReturns:

TDropDownBuilder

Example:

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

GroupTemplate(string)

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

public TDropDownBuilder GroupTemplate(string groupTemplate)

Parameters:groupTemplatestringReturns:

TDropDownBuilder

GroupTemplate<TModel>(TemplateBuilder<TModel>)

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

public TDropDownBuilder GroupTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the fixed group template.

Returns:

TDropDownBuilder

GroupTemplateHandler(string)

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

public TDropDownBuilder GroupTemplateHandler(string value)

Parameters:valuestringReturns:

TDropDownBuilder

GroupTemplateId(string)

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

public TDropDownBuilder GroupTemplateId(string groupTemplateId)

Parameters:groupTemplateIdstringReturns:

TDropDownBuilder

GroupTemplateView(MvcHtmlString)

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

public TDropDownBuilder GroupTemplateView(MvcHtmlString groupTemplateView)

Parameters:groupTemplateViewMvcHtmlStringReturns:

TDropDownBuilder

HeaderTemplate(string)

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

public TDropDownBuilder HeaderTemplate(string headerTemplate)

Parameters:headerTemplatestringReturns:

TDropDownBuilder

Example:

@( Html.Kendo().DropDownList()
.Name("DropDownList")
.HeaderTemplate("Customers")
)

HeaderTemplate<TModel>(TemplateBuilder<TModel>)

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

public TDropDownBuilder HeaderTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the fixed group template.

Returns:

TDropDownBuilder

HeaderTemplateHandler(string)

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

public TDropDownBuilder HeaderTemplateHandler(string value)

Parameters:valuestringReturns:

TDropDownBuilder

HeaderTemplateId(string)

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

public TDropDownBuilder HeaderTemplateId(string headerTemplateId)

Parameters:headerTemplateIdstringReturns:

TDropDownBuilder

Example:

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

HeaderTemplateView(MvcHtmlString)

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

public TDropDownBuilder HeaderTemplateView(MvcHtmlString headerTemplateView)

Parameters:headerTemplateViewMvcHtmlStringReturns:

TDropDownBuilder

Example:

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

Height(int)

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

public TDropDownBuilder Height(int height)

Parameters:heightintReturns:

TDropDownBuilder

Example:

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

IgnoreCase(bool)

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

public TDropDownBuilder IgnoreCase(bool ignoreCase)

Parameters:ignoreCaseboolReturns:

TDropDownBuilder

Example:

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

Label(Action<LabelSettingsBuilder>)

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.

public TDropDownBuilder Label(Action<LabelSettingsBuilder> configurator)

Parameters:configuratorAction<LabelSettingsBuilder>Returns:

TDropDownBuilder

NoDataTemplate(string)

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

public TDropDownBuilder NoDataTemplate(string noDataTemplate)

Parameters:noDataTemplatestringReturns:

TDropDownBuilder

Example:

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

NoDataTemplate<TModel>(TemplateBuilder<TModel>)

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

public TDropDownBuilder NoDataTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the fixed group template.

Returns:

TDropDownBuilder

NoDataTemplateHandler(string)

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

public TDropDownBuilder NoDataTemplateHandler(string value)

Parameters:valuestringReturns:

TDropDownBuilder

NoDataTemplateId(string)

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

public TDropDownBuilder NoDataTemplateId(string noDataTemplateId)

Parameters:noDataTemplateIdstringReturns:

TDropDownBuilder

Example:

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

NoDataTemplateView(MvcHtmlString)

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

public TDropDownBuilder NoDataTemplateView(MvcHtmlString noDataTemplateView)

Parameters:noDataTemplateViewMvcHtmlStringReturns:

TDropDownBuilder

Example:

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

Popup(Action<PopupSettingsBuilder>)

Configures the popup settings of the widget.

public TDropDownBuilder Popup(Action<PopupSettingsBuilder> popupAction)

Parameters:popupActionAction<PopupSettingsBuilder>Returns:

TDropDownBuilder

ValuePrimitive(bool)

Specifies whether the value of the widget should be treated as a plain string or as a complex object from the data source.

public TDropDownBuilder ValuePrimitive(bool valuePrimitive)

Parameters:valuePrimitiveboolReturns:

TDropDownBuilder

Virtual(Action<VirtualSettingsBuilder>)

Configures the virtualization settings of the widget.

public TDropDownBuilder Virtual(Action<VirtualSettingsBuilder> virtualizationAction)

Parameters:virtualizationActionAction<VirtualSettingsBuilder>Returns:

TDropDownBuilder

Virtual(bool)

Configures the virtualization settings of the widget.

public TDropDownBuilder Virtual(bool enable)

Parameters:enableboolReturns:

TDropDownBuilder