Kendo.Mvc.UI.Fluent.TreeViewBuilder

Defines the fluent interface for configuring the TreeView component.

Methods

AutoBind(System.Boolean)

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

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .AutoBind(false)
%>

CheckboxTemplate(System.String)

Template to be used for rendering the item checkboxes in the treeview.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .CheckboxTemplate("#= data #")
%>

CheckboxTemplateId(System.String)

Id of the template element to be used for rendering the item checkboxes in the treeview.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .CheckboxTemplateId("widgetTemplateId")
%>

Template(System.String)

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

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Template("#= data #")
%>

TemplateId(System.String)

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

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .TemplateId("widgetTemplateId")
%>

Checkboxes(System.Boolean)

Enable/disable rendering of checkboxes in the treeview.

Parameters

enabled System.Boolean

Whether checkboxes should be rendered.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Checkboxes(true)
%>

Checkboxes(System.Action<Kendo.Mvc.UI.Fluent.TreeViewCheckboxesBuilder>)

Configures rendering of checkboxes in the treeview.

Parameters

configure System.Action<Kendo.Mvc.UI.Fluent.TreeViewCheckboxesBuilder>

Builder of the treeview checkboxes configuration.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Checkboxes(config => config
        .CheckChildren(true)
    )
%>

Items(System.Action<Kendo.Mvc.UI.Fluent.TreeViewItemFactory>)

Defines the items in the TreeView

Parameters

addAction System.Action<Kendo.Mvc.UI.Fluent.TreeViewItemFactory>

The add action.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Items(items =>
    {
        items.Add().Text("First Item");
        items.Add().Text("Second Item");
    })
%>

Events(System.Action<Kendo.Mvc.UI.Fluent.TreeViewEventBuilder>)

Configures the client-side events.

Parameters

clientEventsAction System.Action<Kendo.Mvc.UI.Fluent.TreeViewEventBuilder>

The client events action.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Events(events =>
        .OnDataBinding("onDataBinding")
        .OnItemDataBound("onItemDataBound")
    )
%>

BindTo(System.String,System.Action<Kendo.Mvc.UI.TreeViewItem,Kendo.Mvc.SiteMapNode>)

Binds the TreeView to a sitemap

Parameters

viewDataKey System.String

The view data key.

siteMapAction System.Action<Kendo.Mvc.UI.TreeViewItem,Kendo.Mvc.SiteMapNode>

The action to configure the item.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .BindTo("examples", (item, siteMapNode) =>
    {
    })
%>

BindTo(System.String)

Binds the TreeView to a sitemap.

Parameters

viewDataKey System.String

The view data key.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .BindTo("examples")
%>

BindTo(System.Collections.Generic.IEnumerable<Kendo.Mvc.UI.TreeViewItemModel>)

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

Parameters

items System.Collections.Generic.IEnumerable<Kendo.Mvc.UI.TreeViewItemModel>

The list of items

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .BindTo(model)
%>

BindTo(System.Collections.Generic.IEnumerable<T1>,System.Action<Kendo.Mvc.UI.TreeViewItem,T1>)

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

Parameters

dataSource System.Collections.Generic.IEnumerable<T1>

The data source.

itemDataBound System.Action<Kendo.Mvc.UI.TreeViewItem,T1>

The action executed for every data bound item.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .BindTo(new []{"First", "Second"}, (item, value) =>
    {
        item.Text = value;
    })
%>

BindTo(System.Collections.IEnumerable,System.Action<Kendo.Mvc.UI.Fluent.NavigationBindingFactory<Kendo.Mvc.UI.TreeViewItem>>)

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

Parameters

dataSource System.Collections.IEnumerable

The data source.

factoryAction System.Action<Kendo.Mvc.UI.Fluent.NavigationBindingFactory>

The action which will configure the mappings

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .BindTo(Model, mapping => mapping
        .For<Customer>(binding => binding
            .Children(c => c.Orders) // The "child" items will be bound to the the "Orders" property
            .ItemDataBound((item, c) => item.Text = c.ContactName) // Map "Customer" properties to TreeViewItem properties
        )
        .For<Order<(binding => binding
            .Children(o => null) // "Orders" do not have child objects so return "null"
            .ItemDataBound((item, o) => item.Text = o.OrderID.ToString()) // Map "Order" properties to TreeViewItem properties
        )
    )
%>

ItemAction(System.Action<Kendo.Mvc.UI.TreeViewItem>)

Callback for each item.

Parameters

action System.Action<Kendo.Mvc.UI.TreeViewItem>

Action, which will be executed for each item.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .ItemAction(item =>
    {
        item
        .Text(...)
        .HtmlAttributes(...);
    })
%>

HighlightPath(System.Boolean)

Select item depending on the current URL.

Parameters

value System.Boolean

If true the item will be highlighted.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .HighlightPath(true)
%>

Animation(System.Boolean)

Use to enable or disable animation of the TreeView.

Parameters

enable System.Boolean

The boolean value.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Animation(false) //toggle effect
%>

Animation(System.Action<Kendo.Mvc.UI.Fluent.ExpandableAnimationBuilder>)

Configures the animation effects of the widget.

Parameters

animationAction System.Action<Kendo.Mvc.UI.Fluent.ExpandableAnimationBuilder>

The action which configures the animation effects.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Animation(animation =>
    {
        animation.Expand(open =>
        {
            open.SlideIn(SlideDirection.Down);
            });
        })
        %>

ExpandAll(System.Boolean)

Expand all the items.

Parameters

value System.Boolean

If true all the items will be expanded.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .ExpandAll(true)
%>

DragAndDrop(System.Boolean)

Enables drag & drop between treeview nodes.

Parameters

value System.Boolean

If true, drag & drop is enabled.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .Items(items =>
    {
        items.Add().Text("First Item");
        items.Add().Text("Second Item");
    })
    .DragAndDrop(true)
%>

SecurityTrimming(System.Boolean)

Enable/disable security trimming functionality of the component.

Parameters

value System.Boolean

If true security trimming is enabled.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .SecurityTrimming(false)
%>

SecurityTrimming(System.Action<Kendo.Mvc.UI.SecurityTrimmingBuilder>)

Defines the security trimming functionality of the component

Parameters

securityTrimmingAction System.Action<Kendo.Mvc.UI.SecurityTrimmingBuilder>

The securityTrimming action.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .SecurityTrimming(builder =>
    {
        builder.Enabled(true).HideParent(true);
    })
%>

DataSource(System.Action<Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder<System.Object>>)

Configure the DataSource of the component

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder>

The action that configures the DataSource.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .DataSource(dataSource => dataSource
        .Read(read => read
            .Action("Employees", "TreeView")
        )
    )
%>

LoadOnDemand(System.Boolean)

Allows the treeview to fetch the entire datasource at initialization time.

Parameters

value System.Boolean

Whether the datasource should be loaded on demand.

Example (ASPX)

<%= Html.Kendo().TreeView()
    .Name("TreeView")
    .LoadOnDemand(false)
%>

AutoScroll(System.Boolean)

If set to true the widget will auto-scroll the containing element when the mouse/finger is close to the top/bottom of it.

Parameters

value System.Boolean

The value that configures the autoscroll.

DataImageUrlField(System.String)

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

Parameters

value System.String

The value that configures the dataimageurlfield.

DataSpriteCssClassField(System.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.

Parameters

value System.String

The value that configures the dataspritecssclassfield.

DataUrlField(System.String)

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

Parameters

value System.String

The value that configures the dataurlfield.

Messages(System.Action<Kendo.Mvc.UI.Fluent.TreeViewMessagesSettingsBuilder>)

The text messages displayed in the widget. Use it to customize or localize the messages.

Parameters

configurator System.Action<Kendo.Mvc.UI.Fluent.TreeViewMessagesSettingsBuilder>

The action that configures the messages.

DataTextField(System.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.

Parameters

value System.String[]

The value that configures the datatextfield.