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

DropDownTreeBuilder

Class

Defines the fluent interface for configuring the DropDownTree component.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class DropDownTreeBuilder : WidgetBuilderBase<DropDownTree, DropDownTreeBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<DropDownTree, DropDownTreeBuilder>DropDownTreeBuilder

Implements: IHtmlString

Constructors

DropDownTreeBuilder(DropDownTree)

Initializes a new instance of the DropDownTreeBuilder class.

public DropDownTreeBuilder(DropDownTree component)

Parameters:componentDropDownTree

The component.

Methods

AdaptiveMode(AdaptiveMode)

Specifies the adaptive rendering of the component.

public DropDownTreeBuilder AdaptiveMode(AdaptiveMode value)

Parameters:valueAdaptiveMode

The value for AdaptiveMode.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.AdaptiveMode(AdaptiveMode.Auto)
)

AdaptiveSubtitle(string)

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

public DropDownTreeBuilder AdaptiveSubtitle(string value)

Parameters:valuestring

The value that configures the adaptivesubtitle.

Returns:

DropDownTreeBuilder

AdaptiveTitle(string)

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

public DropDownTreeBuilder AdaptiveTitle(string value)

Parameters:valuestring

The value that configures the adaptivetitle.

Returns:

DropDownTreeBuilder

Animation(Action<PopupAnimationBuilder>)

Configures the animation effects of the widget.

public DropDownTreeBuilder Animation(Action<PopupAnimationBuilder> animationAction)

Parameters:animationActionAction<PopupAnimationBuilder>

The action which configures the animation effects.

Returns:

DropDownTreeBuilder

Example:

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

Animation(bool)

Use to enable or disable animation of the DropDownTree.

public DropDownTreeBuilder Animation(bool enable)

Parameters:enablebool

The boolean value.

Returns:

DropDownTreeBuilder

Example:

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

AutoBind(bool)

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

public DropDownTreeBuilder AutoBind(bool autoBind)

Parameters:autoBindbool

The value for autoBind

Returns:

DropDownTreeBuilder

Example:

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

AutoClose(bool)

Controls whether to close the popup when item is selected or checked.

public DropDownTreeBuilder AutoClose(bool autoClose)

Parameters:autoClosebool

The value for AutoClose

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.AutoClose(true)
)

AutoWidth(bool)

If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.

public DropDownTreeBuilder AutoWidth(bool autoWidth)

Parameters:autoWidthbool

The value for AutoWidth

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.AutoWidth(true)
)

BindTo(IEnumerable, Action<NavigationBindingFactory<DropDownTreeItem>>)

Binds the DropDownTree to a list of objects. The DropDownTree will create a hierarchy of items using the specified mappings.

public DropDownTreeBuilder BindTo(IEnumerable dataSource, Action<NavigationBindingFactory<DropDownTreeItem>> factoryAction)

Parameters:dataSourceIEnumerable

The data source.

factoryActionAction<NavigationBindingFactory<DropDownTreeItem>>

The action which will configure the mappings

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.BindTo(Model, mapping =&gt; mapping
.For&lt;Customer&gt;(binding =&gt; binding
.Children(c =&gt; c.Orders) // The "child" items will be bound to the "Orders" property
.ItemDataBound((item, c) =&gt; item.Text = c.ContactName) // Map "Customer" properties to DropDownTreeItem properties
)
.For&lt;Order&lt;(binding =&gt; binding
.Children(o =&gt; null) // "Orders" do not have child objects so return "null"
.ItemDataBound((item, o) =&gt; item.Text = o.OrderID.ToString()) // Map "Order" properties to DropDownTreeItem properties
)
)
)

BindTo(IEnumerable<DropDownTreeItemModel>)

Binds the DropDownTree to a list of items. Use if a hierarchy of items is being sent from the controller; to bind the DropDownTree declaratively, use the Items() method.

public DropDownTreeBuilder BindTo(IEnumerable<DropDownTreeItemModel> items)

Parameters:itemsIEnumerable<DropDownTreeItemModel>

The list of items

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.BindTo(model)
)

BindTo(string, Action<DropDownTreeItem, SiteMapNode>)

Binds the DropDownTree to a sitemap

public DropDownTreeBuilder BindTo(string viewDataKey, Action<DropDownTreeItem, SiteMapNode> siteMapAction)

Parameters:viewDataKeystring

The view data key.

siteMapActionAction<DropDownTreeItem, SiteMapNode>

The action to configure the item.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.BindTo("examples", (item, siteMapNode) =&gt;
{
})
)

BindTo(string)

Binds the DropDownTree to a sitemap.

public DropDownTreeBuilder BindTo(string viewDataKey)

Parameters:viewDataKeystring

The view data key.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.BindTo("examples")
)

BindTo<T>(IEnumerable<T>, Action<DropDownTreeItem, T>)

Binds the DropDownTree to a list of objects. The DropDownTree will be "flat" which means a DropDownTree item will be created for every item in the data source.

public DropDownTreeBuilder BindTo<T>(IEnumerable<T> dataSource, Action<DropDownTreeItem, T> itemDataBound)

Parameters:dataSourceIEnumerable<T>

The data source.

itemDataBoundAction<DropDownTreeItem, T>

The action executed for every data bound item.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.BindTo(new []{"First", "Second"}, (item, value) =&gt;
{
item.Text = value;
})
)

When this options is set to true and checkboxes are enabled, a tristate checkbox appears above the embedded treeview. Clicking that checkbox will check or uncheck all the loaded enabled items of the treeview.

public DropDownTreeBuilder CheckAll(bool checkAll)

Parameters:checkAllbool

The value for CheckAll

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.CheckAll(true)
.Checkboxes(true)
)

CheckAllTemplate(string)

The template used to render the checkAll label. By default, the widget displays only a span element with text "Check all".

public DropDownTreeBuilder CheckAllTemplate(string value)

Parameters:valuestring

The value for CheckAllTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.CheckAllTemplate("Check All Label")
)

CheckAllTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template used to render the "checkAll" label. By default, the component displays a "span" element with text "Check all".

public DropDownTreeBuilder CheckAllTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the "checkAll" label template.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.CheckAll(true)
.CheckAllTemplate(Html.Kendo().Template().AddHtml("&lt;h2&gt;Check ALL items&lt;/h2&gt;"))
)

CheckAllTemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the checkAll label of the dropdowntree.

public DropDownTreeBuilder CheckAllTemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.CheckAllTemplateHandler("checkAllTemplateHandler")
)

CheckAllTemplateId(string)

The template used to render the checkAll label. By default, the widget displays only a span element with text "Check all".

public DropDownTreeBuilder CheckAllTemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for CheckAllTemplate

Returns:

DropDownTreeBuilder

Example:

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

CheckAllTemplateView(MvcHtmlString)

The template used to render the checkAll label. By default, the widget displays only a span element with text "Check all".

public DropDownTreeBuilder CheckAllTemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains CheckAllTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.CheckAllTemplateView(Html.Partial("TemplateView"))
)

Checkboxes(Action<DropDownTreeCheckboxesBuilder>)

Configures rendering of checkboxes in the dropdowntree.

public DropDownTreeBuilder Checkboxes(Action<DropDownTreeCheckboxesBuilder> configure)

Parameters:configureAction<DropDownTreeCheckboxesBuilder>

Builder of the dropdowntree checkboxes configuration.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Checkboxes(config =&gt; config
.CheckChildren(true)
)
)

Checkboxes(bool)

Enable/disable rendering of checkboxes in the dropdowntree.

public DropDownTreeBuilder Checkboxes(bool enabled)

Parameters:enabledbool

Whether checkboxes should be rendered.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Checkboxes(true)
)

ClearButton(bool)

Unless this option is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.

public DropDownTreeBuilder ClearButton(bool value)

Parameters:valuebool

The value for ClearButton

Returns:

DropDownTreeBuilder

Example:

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

DataImageUrlField(string)

Sets the field of the data item that provides the image URL of the DropDownTree nodes.

public DropDownTreeBuilder DataImageUrlField(string value)

Parameters:valuestring

The value that configures the dataimageurlfield.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataImageUrlField("ImageUrl")
)

DataSource(Action<HierarchicalDataSourceBuilder<object>>)

Configure the DataSource of the component

public DropDownTreeBuilder DataSource(Action<HierarchicalDataSourceBuilder<object>> configurator)

Parameters:configuratorAction<HierarchicalDataSourceBuilder<object>>

The action that configures the DataSource.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read
.Action("Employees", "DropDownTree")
)
)
)

DataSource(string)

Accepts the Name of the external DataSource component that is to be used for data binding

public DropDownTreeBuilder DataSource(string dataSourceId)

Parameters:dataSourceIdstring

The name of the external DataSource.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataSource("dataSourceName")
)

DataSpriteCssClassField(string)

Sets the field of the data item that provides the sprite CSS class of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

public DropDownTreeBuilder DataSpriteCssClassField(string value)

Parameters:valuestring

The value that configures the dataspritecssclassfield.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataSpriteCssClassField("SpriteCssClass")
)

DataTextField(params string[])

Sets the field of the data item that provides the text content of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

public DropDownTreeBuilder DataTextField(params string[] value)

Parameters:valuestring[]

The value that configures the datatextfield.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataTextField([{"Name"}])
)

DataTextField(string)

Sets the field of the data item that provides the text content of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

public DropDownTreeBuilder DataTextField(string value)

Parameters:valuestring

The value that configures the datatextfield.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataTextField("Name")
)

DataUrlField(string)

Sets the field of the data item that provides the link URL of the nodes.

public DropDownTreeBuilder DataUrlField(string value)

Parameters:valuestring

The value that configures the dataurlfield.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataUrlField("Url")
)

DataValueField(string)

The field of the data item that provides the value of the widget. If an array, each level uses the field that is at the same index in the array, or the last item in the array.

public DropDownTreeBuilder DataValueField(string value)

Parameters:valuestring

The value for DataValueField

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.DataValueField("Value")
)

Delay(int)

Specifies the delay in milliseconds after which the DropDownTree will start filtering dataSource.

public DropDownTreeBuilder Delay(int value)

Parameters:valueint

The value for Delay

Returns:

DropDownTreeBuilder

Example:

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

Enable(bool)

If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.

public DropDownTreeBuilder Enable(bool value)

Parameters:valuebool

The value for Enable

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Enable(false)
)

EnforceMinLength(bool)

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 DropDownTreeBuilder EnforceMinLength(bool value)

Parameters:valuebool

The value for EnforceMinLength

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.MinLength(3)
.EnforceMinLength(true)
)

Events(Action<DropDownTreeEventBuilder>)

Configures the client-side events.

public DropDownTreeBuilder Events(Action<DropDownTreeEventBuilder> clientEventsAction)

Parameters:clientEventsActionAction<DropDownTreeEventBuilder>

The client events action.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Events(events =&gt;
.OnDataBinding("onDataBinding")
.OnItemDataBound("onItemDataBound")
)
)

FillMode(FillMode)

Sets a value controlling how the color is applied to the DropDownTree.

public DropDownTreeBuilder FillMode(FillMode value)

Parameters:valueFillMode

The value for FillMode

Returns:

DropDownTreeBuilder

Example:

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

Filter(string)

The filtering method used to determine the suggestions for the current value. Filtration is turned off by default.

public DropDownTreeBuilder Filter(string value)

Parameters:valuestring

The value for Filter

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.ValuePrimitive(true)
)

FilterLabel(string)

When filtering is enabled, allows aria-label to be defined for the filter input element.

public DropDownTreeBuilder FilterLabel(string value)

Parameters:valuestring

The value for FilterLabel

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.FilterLabel("Filter")
)

FooterTemplate(string)

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

public DropDownTreeBuilder FooterTemplate(string value)

Parameters:valuestring

The value for FooterTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.FooterTemplate("Footer Text")
)

FooterTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template that renders the footer of the DropDownTree.

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

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the footer.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.FooterTemplate(Html.Kendo().Template().AddHtml("Total &lt;strong&gt;${data.instance.dataSource.total()}&lt;/strong&gt; items found"))
)

FooterTemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the footer of the dropdowntree.

public DropDownTreeBuilder FooterTemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.FooterTemplateHandler("footerTemplateHandler")
)

FooterTemplateId(string)

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

public DropDownTreeBuilder FooterTemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for FooterTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.FooterTemplateId("footerTemplate")
)

FooterTemplateView(MvcHtmlString)

The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.

public DropDownTreeBuilder FooterTemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains FooterTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.FooterTemplateView(Html.Partial("Template"))
)

HeaderTemplate(string)

Specifies a static HTML content, which will be rendered as a header of the popup element.

public DropDownTreeBuilder HeaderTemplate(string value)

Parameters:valuestring

The value for HeaderTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.HeaderTemplate("Custom Header")
)

HeaderTemplate<TModel>(TemplateBuilder<TModel>)

Specifies a static HTML content, which will be rendered as a header of the popup element.

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

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the header of the popup element.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.HeaderTemplate(Html.Kendo().Template().AddHtml("&lt;div&gt;Countries:&lt;/div&gt;"))
)

HeaderTemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the header content in the dropdowntree.

public DropDownTreeBuilder HeaderTemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.HeaderTemplateHandler("headerTemplateHandler")
)

HeaderTemplateId(string)

Specifies a static HTML content, which will be rendered as a header of the popup element.

public DropDownTreeBuilder HeaderTemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for HeaderTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.HeaderTemplateId("headerTemplate")
)

HeaderTemplateView(MvcHtmlString)

Specifies a static HTML content, which will be rendered as a header of the popup element.

public DropDownTreeBuilder HeaderTemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains the HeaderTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.HeaderTemplateView(Html.Partial("Template"))
)

Height(string)

The height of the suggestion popup in pixels. The default value is 200 pixels. If set to "Auto" the height of the popup will depend on the height of the treeview.

public DropDownTreeBuilder Height(string value)

Parameters:valuestring

The value for Height

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Height("Auto")
)

IgnoreCase(bool)

If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.

public DropDownTreeBuilder IgnoreCase(bool value)

Parameters:valuebool

The value for IgnoreCase

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.IgnoreCase(false)
)

Items(Action<DropDownTreeItemFactory>)

Defines the items in the DropDownTree through the DropDownTreeItemFactory

public DropDownTreeBuilder Items(Action<DropDownTreeItemFactory> addAction)

Parameters:addActionAction<DropDownTreeItemFactory>

The add action.

Returns:

DropDownTreeBuilder

Example:

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

Label(Action<DropDownTreeLabelSettingsBuilder>)

Uses the DropDownTreeLabelSettingsBuilder Action configurator to add 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 DropDownTreeBuilder Label(Action<DropDownTreeLabelSettingsBuilder> configurator)

Parameters:configuratorAction<DropDownTreeLabelSettingsBuilder>Returns:

DropDownTreeBuilder

LoadOnDemand()

Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to true causes loading the child DataSources when expanding the parent node.

public DropDownTreeBuilder LoadOnDemand()

Returns:

DropDownTreeBuilder

LoadOnDemand(Action<DropDownTreeLoadOnDemandSettingsBuilder>)

Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to true causes loading the child DataSources when expanding the parent node.

public DropDownTreeBuilder LoadOnDemand(Action<DropDownTreeLoadOnDemandSettingsBuilder> configurator)

Parameters:configuratorAction<DropDownTreeLoadOnDemandSettingsBuilder>

The configurator for the loadondemand setting.

Returns:

DropDownTreeBuilder

LoadOnDemand(bool)

Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to true causes loading the child DataSources when expanding the parent node.

public DropDownTreeBuilder LoadOnDemand(bool enabled)

Parameters:enabledbool

Enables or disables the loadondemand option.

Returns:

DropDownTreeBuilder

Messages(Action<DropDownTreeMessagesSettingsBuilder>)

The DropDownTreeMessagesSettingsBuilder that configures the messages displayed in the widget. Use it to customize or localize the messages.

public DropDownTreeBuilder Messages(Action<DropDownTreeMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<DropDownTreeMessagesSettingsBuilder>

The action that configures the messages.

Returns:

DropDownTreeBuilder

MinLength(int)

The minimum number of characters the user must type before a search is performed. Set to a higher value if the search could match a lot of items.

public DropDownTreeBuilder MinLength(int value)

Parameters:valueint

The value for MinLength

Returns:

DropDownTreeBuilder

Example:

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

NoDataTemplate(string)

The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.

public DropDownTreeBuilder NoDataTemplate(string value)

Parameters:valuestring

The value for NoDataTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.NoDataTemplate("No items are available")
)

NoDataTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template that renders the "no data" template, which will be displayed if no results are found or the underlying DataSource is empty. The template will be evaluated on every component's data bound.

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

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the "no data" template.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.NoDataTemplate(Html.Kendo().Template().AddHtml("No available options."))
)

NoDataTemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the message when no data loaded in the dropdowntree.

public DropDownTreeBuilder NoDataTemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.NoDataTemplateHandler("noDataTemplateHandler")
)

NoDataTemplateId(string)

public DropDownTreeBuilder NoDataTemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for NoDataTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.NoDataTemplateId("noDataTemplate")
)

NoDataTemplateView(MvcHtmlString)

public DropDownTreeBuilder NoDataTemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains NoDataTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.NoDataTemplateView(Html.Partial("Template"))
)

Placeholder(string)

The hint displayed by the widget when it is empty. Not set by default.

public DropDownTreeBuilder Placeholder(string value)

Parameters:valuestring

The value for Placeholder

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.Placeholder("Select an item")
)

Popup(Action<PopupSettingsBuilder>)

Configures the PopupSettingsBuilder of the widget.

public DropDownTreeBuilder Popup(Action<PopupSettingsBuilder> popupAction)

Parameters:popupActionAction<PopupSettingsBuilder>

The PopupSettingsBuilder Action responsible for the configuration of the Popup.

Returns:

DropDownTreeBuilder

Rounded(Rounded?)

Sets the border radius of the DropDownTree.

public DropDownTreeBuilder Rounded(Rounded? value)

Parameters:valueRounded?

The value for Rounded

Returns:

DropDownTreeBuilder

Example:

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

Size(ComponentSize?)

Sets the size of the component with a parameter of type ComponentSize

public DropDownTreeBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size

Returns:

DropDownTreeBuilder

Example:

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

TagMode(TagMode)

Represents available tag modes of DropDownTree. Available configurations are DropDownTreeTagMode.Single and DropDownTreeTagMode.Multiple

public DropDownTreeBuilder TagMode(TagMode value)

Parameters:valueTagMode

The value for TagMode

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.TagMode(DropDownTreeTagMode.Single)
)

Template(string)

Template to be used for rendering of the items in the dropdowntree.

public DropDownTreeBuilder Template(string template)

Parameters:templatestringReturns:

DropDownTreeBuilder

Example:

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

Template<TModel>(TemplateBuilder<TModel>)

Defines the template that renders each DropDownTree item.

public DropDownTreeBuilder Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures each item's template.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.Template(Html.Kendo().Template().AddHtml("Option: ${data.item.text}"))
)

TemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the items in the dropdowntree.

public DropDownTreeBuilder TemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.TemplateHandler("templateHandler")
)

TemplateId(string)

Id of the template element to be used for rendering the items in the dropdowntree.

public DropDownTreeBuilder TemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for TemplateId

Returns:

DropDownTreeBuilder

Example:

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

TemplateView(MvcHtmlString)

A Partial View to be used for the rendering of the items in the dropdowntree.

public DropDownTreeBuilder TemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains the items template

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.TemplateView(Html.Partial("TemplateView"))
)

Text(string)

The text of the widget used when the autoBind is set to false.

public DropDownTreeBuilder Text(string value)

Parameters:valuestring

The value for Text

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.AutoBind(false)
.Text("Default Text")
)

Value(IEnumerable)

Define the value of the widget. It accepts an 'Array' when multiple selection is enabled via checkboxes property.

public DropDownTreeBuilder Value(IEnumerable value)

Parameters:valueIEnumerable

The value array for Value

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.TagMode(DropDownTreeTagMode.Multiple)
.Value(new string[] { "1" })
)

Value(string)

Define the value of the widget. It accepts 'String' when it is in single selection mode.

public DropDownTreeBuilder Value(string value)

Parameters:valuestring

The value string for Value

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.TagMode(DropDownTreeTagMode.Single)
.Value("1")
)

ValuePrimitive(bool)

Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.

public DropDownTreeBuilder ValuePrimitive(bool value)

Parameters:valuebool

The value for ValuePrimitive

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("DropDownTree")
.ValuePrimitive(true)
)

ValueTemplate(string)

The template used to render the selected tags.

public DropDownTreeBuilder ValueTemplate(string value)

Parameters:valuestring

The value for ValueTemplate

Returns:

DropDownTreeBuilder

Example:

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

ValueTemplate<TModel>(TemplateBuilder<TModel>)

Defines the template used to render the selected value of the DropDownTree.

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

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the selected value template.

Returns:

DropDownTreeBuilder

Example:

@(Html.Kendo().DropDownTree()
.Name("dropDownTree")
.ValueTemplate(Html.Kendo().Template().AddHtml("Item: ${data.text}"))
)

ValueTemplateHandler(string)

Specifies a JavaScript function name. The value returned by thе function will bе used to render the selected value of the dropdowntree.

public DropDownTreeBuilder ValueTemplateHandler(string value)

Parameters:valuestring

The name of the JavaScript function that will handle the template evaluation.

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.ValueHandler("valueTemplateHandler")
)

ValueTemplateId(string)

The template used to render the selected tags.

public DropDownTreeBuilder ValueTemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for ValueTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.ValueTemplateId("valueTemplate")
)

ValueTemplateView(MvcHtmlString)

The template used to render the selected tags.

public DropDownTreeBuilder ValueTemplateView(MvcHtmlString templateView)

Parameters:templateViewMvcHtmlString

The view that contains the ValueTemplate

Returns:

DropDownTreeBuilder

Example:

@( Html.Kendo().DropDownTree()
.Name("DropDownTree")
.ValueTemplateView(Html.Partial("Template"))
)