TreeViewBuilder
Defines the fluent API for configuring the Kendo UI TreeView
Properties
WriteAction - Func
Methods
Items(System.Action)
Defines the items in the TreeView
Parameters
addAction - System.Action<TreeViewItemFactory>
The add action.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.Items(items =>
{
items.Add().Text("First Item");
items.Add().Text("Second Item");
})
%>
HighlightPath(System.Boolean)
Select item depending on the current URL.
Parameters
value - System.Boolean
If true the item will be highlighted.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.HighlightPath(true)
%>
ExpandAll(System.Boolean)
Expand all the items.
Parameters
value - System.Boolean
If true all the items will be expanded.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.ExpandAll(true)
%>
DataSource(System.Action)
Configure the DataSource of the component
Parameters
configurator - System.Action<HierarchicalDataSourceBuilder>
The action that configures the Kendo.Mvc.UI.Fluent.TreeViewBuilder.DataSource(System.Action{Kendo.Mvc.UI.Fluent.HierarchicalDataSourceBuilder{System.Object}}).
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.DataSource(dataSource => dataSource
.Read(read => read
.Action("Employees", "TreeView")
)
)
%>
DataSource(System.String)
Set ID of the DataSource that to be used for data binding
Parameters
dataSourceId - System.String
BindTo(System.Collections.Generic.IEnumerable)
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<TreeViewItemModel>
The list of items
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.BindTo(model)
%>
BindTo(System.Collections.IEnumerable,System.Action)
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<NavigationBindingFactory>
The action which will configure the mappings
Example
<%= 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
)
)
%>
BindTo(System.Collections.Generic.IEnumerable,System.Action)
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<T>
The data source.
itemDataBound - System.Action<TreeViewItem,T>
The action executed for every data bound item.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.BindTo(new []{"First", "Second"}, (item, value) =>
{
item.Text = value;
})
%>
Animation(System.Boolean)
Use to enable or disable animation of the TreeView.
Parameters
enable - System.Boolean
The boolean value.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.Animation(false) //toggle effect
%>
Animation(System.Action)
Configures the animation effects of the widget.
Parameters
animationAction - System.Action<ExpandableAnimationBuilder>
The action which configures the animation effects.
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.Animation(animation =>
{
animation.Expand(open =>
{
open.SlideIn(SlideDirection.Down);
});
})
%>
CheckboxTemplate(System.String)
Template to be used for rendering the item checkboxes in the treeview.
Parameters
template - System.String
Example
<%= 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.
Parameters
templateId - System.String
Example
<%= Html.Kendo().TreeView()
.Name("TreeView")
.CheckboxTemplateId("widgetTemplateId")
%>
AutoBind(System.Boolean)
If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
Parameters
value - System.Boolean
The value for AutoBind
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 for AutoScroll
AutoScroll()
If set to true the widget will auto-scroll the containing element when the mouse/finger is close to the top/bottom of it.
Checkboxes(System.Action)
If true or an object, renders checkboxes beside each node.
Parameters
configurator - System.Action<TreeViewCheckboxesSettingsBuilder>
The configurator for the checkboxes setting.
Checkboxes()
If true or an object, renders checkboxes beside each node.
Checkboxes(System.Boolean)
If true or an object, renders checkboxes beside each node.
Parameters
enabled - System.Boolean
Enables or disables the checkboxes option.
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 for 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 for DataSpriteCssClassField
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 for DataTextField
DataUrlField(System.String)
Sets the field of the data item that provides the link URL of the nodes.
Parameters
value - System.String
The value for DataUrlField
DragAndDrop(System.Boolean)
Disables (false) or enables (true) drag-and-drop of the nodes.
Parameters
value - System.Boolean
The value for DragAndDrop
DragAndDrop()
Disables (false) or enables (true) drag-and-drop of the nodes.
LoadOnDemand(System.Boolean)
Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to false causes all child DataSources to be loaded at initialization time.
Parameters
value - System.Boolean
The value for LoadOnDemand
Messages(System.Action)
The text messages displayed in the widget. Use it to customize or localize the messages.
Parameters
configurator - System.Action<TreeViewMessagesSettingsBuilder>
The configurator for the messages setting.
Template(System.String)
Template for rendering each node.
Parameters
value - System.String
The value for Template
TemplateId(System.String)
Template for rendering each node.
Parameters
templateId - System.String
The ID of the template element for Template
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<TreeViewEventBuilder>
The client events action.
Example
@(Html.Kendo().TreeView()
.Name("TreeView")
.Events(events => events
.Change("onChange")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
Render()
Renders the component in place.