TreeListBuilder
Properties
WriteAction - Func
Methods
DataSource(System.Action)
Configure the DataSource of the component
Parameters
configurator - System.Action<TreeListAjaxDataSourceBuilder>
The action that configures the DataSource.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Kendo().TreeList<UserViewModel>()
.Name("TreeList")
.DataSource(dataSource => dataSource
.Read(read => read
.Action("_PopulationUS", "TreeList")
)
)
)
DataSource(System.String)
Binds the TreeList to an existing DataSource instance.
Parameters
dataSourceId - System.String
The name of the client DataSource instance.
Example
@(Html.Kendo().DataSource<ProductViewModel>()
.Name("dataSource1")
.Ajax(dataSource => dataSource
.PageSize(10)
.Read(read => read.Action("Products_Read", "DataSource"))
)
)
@(Html.Kendo().TreeList<ProductViewModel>()
.Name("TreeList")
.DataSource("dataSource1")
)
Selectable()
If set to true the user would be able to select treelist rows. By default selection is disabled.Can also be set to the following string values: row - The user can select a single row. cell - The user can select a single cell. multiple, row - The user can select multiple rows. multiple, cell - The user can select multiple cells.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Selectable()
)
Filterable(System.Action)
If set to true, the user can filter the data source by using the TreeList filter menu. By default, filtering is disabled. Can be set to a JavaScript object which represents the filter menu configuration.
Parameters
configurator - System.Action<TreeListFilterableSettingsBuilder>
The configurator for the filterable setting.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Filterable(ftb => ftb.Mode("row"))
)
Filterable()
If set to true, the user can filter the data source by using the TreeList filter menu. By default, filtering is disabled. Can be set to a JavaScript object which represents the filter menu configuration.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Filterable(ftb => ftb.Mode("row"))
)
Filterable(System.Boolean)
If set to true, the user can filter the data source by using the TreeList filter menu. By default, filtering is disabled. Can be set to a JavaScript object which represents the filter menu configuration.
Parameters
enabled - System.Boolean
Enables or disables the filterable option.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Filterable(true)
)
Toolbar(System.String)
If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole TreeList toolbar and the string value will be passed as an argument to a kendo.template() function.; If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the contents of the TreeList toolbar. or If an Array value is assigned, it will be treated as the list of commands which are displayed in the TreeList toolbar. Commands can be custom or built-in. The supported built-in commands are:create - Adds an empty data item to the treelist.excel - Exports the TreeList data in MS Excel format.pdf - Exports the TreeList data in PDF format.search - built-in search panel for the TreeList..
Parameters
template - System.String
The template for the toolbar.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Toolbar("Template value")
)
Toolbar(Kendo.Mvc.UI.Fluent.TemplateBuilder)
If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole TreeList toolbar and the string value will be passed as an argument to a kendo.template() function.; If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the contents of the TreeList toolbar. or If an Array value is assigned, it will be treated as the list of commands which are displayed in the TreeList toolbar. Commands can be custom or built-in. The supported built-in commands are:create - Adds an empty data item to the treelist.excel - Exports the TreeList data in MS Excel format.pdf - Exports the TreeList data in PDF format.search - built-in search panel for the TreeList..
Parameters
template - TemplateBuilder<TModel>
The template component which contains the template.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.Toolbar(t =>
{
t.Custom(Html.Kendo()
.Template()
.AddComponent(c => c.Button()
.Name("refresh"));
}))
)
ToolbarTemplateHandler(System.String)
If a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole TreeList toolbar and the string value will be passed as an argument to a kendo.template() function.; If a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the contents of the TreeList toolbar. or If an Array value is assigned, it will be treated as the list of commands which are displayed in the TreeList toolbar. Commands can be custom or built-in. The supported built-in commands are:create - Adds an empty data item to the treelist.excel - Exports the TreeList data in MS Excel format.pdf - Exports the TreeList data in PDF format.search - built-in search panel for the TreeList..
Parameters
handler - System.String
The view which contains the template.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.ToolbarTemplateHandler("TemplateHandler")
)
ToolbarTemplateId(System.String)
Sets the id of the script element which contains the client-side toolbar template of the TreeList.
Parameters
template - System.String
The Id of the script element which contains the template.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList<UserViewModel>()
.Name("treelist")
.ToolbarTemplateId("TemplateId")
)
Pageable(System.Action)
If set to true, the TreeList displays a pager. By default, paging is disabled. Only client-side paging is supported which means that all data items are expected to be available when the TreeList is initialized. Can be set to a JavaScript object which represents the pager configuration.
Parameters
configurator - System.Action<TreeListPageableSettingsBuilder>
The configurator for the pageable setting.
RETURNS
Returns the current TreeListBuilder instance.
Toolbar(System.Action)
Use this overload to configure a list of commands which are displayed in the TreeList toolbar.
Parameters
configurator - System.Action<TreeListToolbarFactory>
The configurator for the toolbar setting.
RETURNS
Returns the current TreeListBuilder instance.
Toolbar(System.Action)
Use this overload to configure a list of commands which are displayed in the TreeList toolbar.
Parameters
configurator - System.Action<TreeListToolbarSettingsBuilder>
The configurator for the toolbar setting.
RETURNS
Returns the current TreeListBuilder instance.
AltRowTemplate(System.String)
The template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
Parameters
value - System.String
The value for AltRowTemplate
RETURNS
Returns the current TreeListBuilder instance.
AltRowTemplateId(System.String)
The template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
Parameters
templateId - System.String
The ID of the template element for AltRowTemplate
RETURNS
Returns the current TreeListBuilder instance.
AltRowTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for AltRowTemplate
RETURNS
Returns the current TreeListBuilder instance.
AltRowTemplateHandler(System.String)
The template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
Parameters
templateHandler - System.String
The handler that returs the template for AltRowTemplate
RETURNS
Returns the current TreeListBuilder instance.
AltRowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the alternating table rows. By default the treelist renders a table row (<tr>) for every data source item.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the altrowtemplate.
RETURNS
Returns the current TreeListBuilder instance.
AutoBind(System.Boolean)
If set to false, the TreeList will not bind to the specified DataSource during initialization. In this case, data binding will occur when the change event of the DataSource fires. By default, the TreeList will bind to the DataSource that is specified in the configuration.
Parameters
value - System.Boolean
The value for AutoBind
RETURNS
Returns the current TreeListBuilder instance.
Columns(System.Action)
The configuration of the TreeList columns whcih represents an array of JavaScript objects or strings. JavaScript objects are interpreted as column configurations. Strings are interpreted as thefield to which the column is bound. The TreeList will create a column for each item of the array.
Parameters
configurator - System.Action<TreeListColumnFactory>
The configurator for the columns setting.
RETURNS
Returns the current instance of TreeListBuilder .
Resizable(System.Boolean)
If set to true, the user can resize columns by dragging their header borders. By default, resizing is disabled.
Parameters
value - System.Boolean
The value for Resizable
RETURNS
Returns the current TreeListBuilder instance.
Resizable()
If set to true, the user can resize columns by dragging their header borders. By default, resizing is disabled.
RETURNS
Returns the current TreeListBuilder instance.
Reorderable(System.Boolean)
If set to true, the user can reorder the columns by dragging their header cells. By default, reordering is disabled.
Parameters
value - System.Boolean
The value for Reorderable
RETURNS
Returns the current TreeListBuilder instance.
Reorderable()
If set to true, the user can reorder the columns by dragging their header cells. By default, reordering is disabled.
RETURNS
Returns the current TreeListBuilder instance.
ColumnMenu(System.Action)
If set to true, the TreeList displays the column menu when the user clicks the Chevron icon in the column headers. The column menu allows the user to show and hide columns, and, if filtering and sorting are enabled, filter and sort the data. By default, the column menu is disabled. Can be set to a JavaScript object which represents the column menu configuration.
Parameters
configurator - System.Action<TreeListColumnMenuSettingsBuilder>
The configurator for the columnmenu setting.
RETURNS
Returns the current instance of TreeListBuilder .
ColumnMenu()
If set to true, the TreeList displays the column menu when the user clicks the Chevron icon in the column headers. The column menu allows the user to show and hide columns, and, if filtering and sorting are enabled, filter and sort the data. By default, the column menu is disabled. Can be set to a JavaScript object which represents the column menu configuration.
RETURNS
Returns the current instance of TreeListBuilder .
ColumnMenu(System.Boolean)
If set to true, the TreeList displays the column menu when the user clicks the Chevron icon in the column headers. The column menu allows the user to show and hide columns, and, if filtering and sorting are enabled, filter and sort the data. By default, the column menu is disabled. Can be set to a JavaScript object which represents the column menu configuration.
Parameters
enabled - System.Boolean
Enables or disables the columnmenu option.
RETURNS
Returns the current instance of TreeListColumnMenuSettingsBuilder .
Editable(System.Action)
If set to true, the user will be able to edit the data to which the TreeList is bound. By default, editing is disabled. can be set to a JavaScript object (which represents the editing configuration) or to a string (which specifies the edit mode).The supported string values are: (Default) inline; popup or incell.
Parameters
configurator - System.Action<TreeListEditableSettingsBuilder>
The configurator for the editable setting.
RETURNS
Returns the current instance of TreeListBuilder .
Editable()
If set to true, the user will be able to edit the data to which the TreeList is bound. By default, editing is disabled. can be set to a JavaScript object (which represents the editing configuration) or to a string (which specifies the edit mode).The supported string values are: (Default) inline; popup or incell.
RETURNS
Returns the current instance of TreeListBuilder .
Editable(System.Boolean)
If set to true, the user will be able to edit the data to which the TreeList is bound. By default, editing is disabled. can be set to a JavaScript object (which represents the editing configuration) or to a string (which specifies the edit mode).The supported string values are: (Default) inline; popup or incell.
Parameters
enabled - System.Boolean
Enables or disables the editable option.
RETURNS
Returns the current instance of TreeListEditableSettingsBuilder .
Excel(System.Action)
Configures the Excel export settings of the TreeList.
Parameters
configurator - System.Action<TreeListExcelSettingsBuilder>
The configurator for the excel setting.
RETURNS
Returns the current instance of TreeListBuilder .
Height(System.Double)
The height of the TreeList. Numeric values are treated as pixels.
Parameters
value - System.Double
The value for Height
RETURNS
Returns the current TreeListBuilder instance.
Messages(System.Action)
Defines the text of the command buttons that are shown within the TreeList. Used primarily for localization.
Parameters
configurator - System.Action<TreeListMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of TreeListBuilder .
Navigatable(System.Boolean)
If set to true, the user can navigate the widget with the keyboard. By default, keyboard navigation is disabled. For a runnable example, refer to the demo on keyboard navigation in the TreeList.
Parameters
value - System.Boolean
The value for Navigatable
RETURNS
Returns the current TreeListBuilder instance.
Navigatable()
If set to true, the user can navigate the widget with the keyboard. By default, keyboard navigation is disabled. For a runnable example, refer to the demo on keyboard navigation in the TreeList.
RETURNS
Returns the current TreeListBuilder instance.
Pageable()
If set to true, the TreeList displays a pager. By default, paging is disabled. Only client-side paging is supported which means that all data items are expected to be available when the TreeList is initialized. Can be set to a JavaScript object which represents the pager configuration.
RETURNS
Returns the current TreeListBuilder instance.
Pageable(System.Boolean)
If set to true, the TreeList displays a pager. By default, paging is disabled. Only client-side paging is supported which means that all data items are expected to be available when the TreeList is initialized. Can be set to a JavaScript object which represents the pager configuration.
Parameters
enabled - System.Boolean
Enables or disables the pageable option.
RETURNS
Returns the current instance of TreeListBuilder .
Pdf(System.Action)
Configures the PDF export settings of the TreeList.
Parameters
configurator - System.Action<TreeListPdfSettingsBuilder>
The configurator for the pdf setting.
RETURNS
Returns the current instance of TreeListBuilder .
RowTemplate(System.String)
The template which renders rows. By default renders a table row (<tr>) for every data source item.
Parameters
value - System.String
The value for RowTemplate
RETURNS
Returns the current TreeListBuilder instance.
RowTemplateId(System.String)
The template which renders rows. By default renders a table row (<tr>) for every data source item.
Parameters
templateId - System.String
The ID of the template element for RowTemplate
RETURNS
Returns the current TreeListBuilder instance.
RowTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders rows. By default renders a table row (<tr>) for every data source item.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for RowTemplate
RETURNS
Returns the current TreeListBuilder instance.
RowTemplateHandler(System.String)
The template which renders rows. By default renders a table row (<tr>) for every data source item.
Parameters
templateHandler - System.String
The handler that returs the template for RowTemplate
RETURNS
Returns the current TreeListBuilder instance.
RowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders rows. By default renders a table row (<tr>) for every data source item.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the rowtemplate.
RETURNS
Returns the current TreeListBuilder instance.
Scrollable(System.Boolean)
If set to true, the TreeList will display a scrollbar when the total row height or width exceeds the TreeList height or width. By default, scrolling is enabled. Scrolling renders separate tables for the header and data area. For accessibility-conscious applications, disable scrolling.
Parameters
value - System.Boolean
The value for Scrollable
RETURNS
Returns the current TreeListBuilder instance.
Search(System.Action)
Configures the Kendo UI TreeList search bar settings.
Parameters
configurator - System.Action<TreeListSearchSettingsBuilder>
The configurator for the search setting.
RETURNS
Returns the current instance of TreeListBuilder .
Sortable(System.Action)
If set to true, the user is able to sort the TreeList by clicking the column header cells. By default, sorting is disabled. Can be set to a JavaScript object which represents the sorting configuration.
Parameters
configurator - System.Action<TreeListSortableSettingsBuilder>
The configurator for the sortable setting.
RETURNS
Returns the current instance of TreeListBuilder .
Sortable()
If set to true, the user is able to sort the TreeList by clicking the column header cells. By default, sorting is disabled. Can be set to a JavaScript object which represents the sorting configuration.
RETURNS
Returns the current instance of TreeListBuilder .
Sortable(System.Boolean)
If set to true, the user is able to sort the TreeList by clicking the column header cells. By default, sorting is disabled. Can be set to a JavaScript object which represents the sorting configuration.
Parameters
enabled - System.Boolean
Enables or disables the sortable option.
RETURNS
Returns the current instance of TreeListSortableSettingsBuilder .
Selectable(System.Action)
Specifies whether TreeList selection is allowed. By default selection is disabled
Parameters
configurator - System.Action<TreeListSelectableSettingsBuilder>
The configurator for the selectable setting.
RETURNS
Returns the current instance of TreeListBuilder .
Selectable(System.Boolean)
Specifies whether TreeList selection is allowed. By default selection is disabled
Parameters
enabled - System.Boolean
Enables or disables the selectable option.
RETURNS
Returns the current instance of TreeListSelectableSettingsBuilder .
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<TreeListEventBuilder>
The client events action.
RETURNS
Returns the current TreeListBuilder instance.
Example
@(Html.Kendo().TreeList()
.Name("TreeList")
.Events(events => events
.BeforeEdit("onBeforeEdit")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
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.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.