TreeViewBuilder Methods
A TreeView control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| ActiveStateEnabled(JS) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| ActiveStateEnabled(Boolean) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| AnimationEnabled(JS) | Specifies whether or not to animate item collapsing and expanding. Mirrors the client-side animationEnabled option. |
| AnimationEnabled(Boolean) | Specifies whether or not to animate item collapsing and expanding. Mirrors the client-side animationEnabled option. |
| CollapseIcon(JS) | |
| CollapseIcon(String) | |
| CreateChildren(RazorBlock) | Allows you to load nodes on demand. Mirrors the client-side createChildren option. |
| CreateChildren(String) | Allows you to load nodes on demand. Mirrors the client-side createChildren option. |
| DataSource(JS) | Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) |
Binds a TreeView control to a collection: Array, List, or IEnumerable.
|
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a TreeView control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more. |
| DataSource(String, String[]) | Binds a TreeView control to read-only data in JSON format. |
| DataSourceOptions(Action<DataSourceOptionsBuilder>) | Provides access to methods that mirror client-side data source options. |
| DataStructure(TreeViewDataStructure) | Notifies the UI component of the used data structure. Mirrors the client-side dataStructure option. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| DisabledExpr(JS) | Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled. Mirrors the client-side disabledExpr option. |
| DisabledExpr(String) | Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled. Mirrors the client-side disabledExpr option. |
| DisplayExpr(JS) | Mirrors the client-side displayExpr option. |
| DisplayExpr(String) | Mirrors the client-side displayExpr option. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| ExpandAllEnabled(JS) | Specifies whether or not a user can expand all tree view items by the '*' hot key. Mirrors the client-side expandAllEnabled option. |
| ExpandAllEnabled(Boolean) | Specifies whether or not a user can expand all tree view items by the '*' hot key. Mirrors the client-side expandAllEnabled option. |
| ExpandedExpr(JS) | Specifies which data source field specifies whether an item is expanded. Mirrors the client-side expandedExpr option. |
| ExpandedExpr(String) | Specifies which data source field specifies whether an item is expanded. Mirrors the client-side expandedExpr option. |
| ExpandEvent(TreeViewExpandEvent) | Specifies the event on which to expand/collapse a node. Mirrors the client-side expandEvent option. |
| ExpandIcon(JS) | |
| ExpandIcon(String) | |
| ExpandNodesRecursive(JS) | Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. Mirrors the client-side expandNodesRecursive option. |
| ExpandNodesRecursive(Boolean) | Specifies whether or not all parent nodes of an initially expanded node are displayed expanded. Mirrors the client-side expandNodesRecursive option. |
| FocusStateEnabled(JS) | Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Mirrors the client-side focusStateEnabled option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| HasItemsExpr(JS) | Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. Mirrors the client-side hasItemsExpr option. |
| HasItemsExpr(String) | Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes. Mirrors the client-side hasItemsExpr option. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| HoverStateEnabled(JS) | Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| ItemHoldTimeout(JS) | The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option. |
| ItemHoldTimeout(Double) | The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option. |
| Items(Action<CollectionFactory<TreeViewItemBuilder>>) | Provides access to the client-side items option that represents a TreeView item collection. |
| ItemsExpr(JS) | Specifies which data field contains nested items. Applies only if the dataStructure property is 'tree'. Mirrors the client-side itemsExpr option. |
| ItemsExpr(String) | Specifies which data field contains nested items. Applies only if the dataStructure property is 'tree'. Mirrors the client-side itemsExpr option. |
| ItemTemplate(JS) | Specifies the client-side itemTemplate. |
| ItemTemplate(RazorBlock) | Specifies the client-side itemTemplate. |
| ItemTemplate(TemplateName) | Specifies the client-side itemTemplate. |
| ItemTemplate(String) | Specifies the client-side itemTemplate. |
| KeyExpr(JS) | Specifies which data field provides keys for TreeView items. Mirrors the client-side keyExpr option. |
| KeyExpr(String) | Specifies which data field provides keys for TreeView items. Mirrors the client-side keyExpr option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| NoDataText(JS) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option. |
| NoDataText(String) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnItemClick(RazorBlock) | A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnItemClick(String) | A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnItemCollapsed(RazorBlock) | A function that is executed when a tree view item is collapsed. Mirrors the client-side onItemCollapsed option. |
| OnItemCollapsed(String) | A function that is executed when a tree view item is collapsed. Mirrors the client-side onItemCollapsed option. |
| OnItemContextMenu(RazorBlock) | A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option. |
| OnItemContextMenu(String) | A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option. |
| OnItemExpanded(RazorBlock) | A function that is executed when a tree view item is expanded. Mirrors the client-side onItemExpanded option. |
| OnItemExpanded(String) | A function that is executed when a tree view item is expanded. Mirrors the client-side onItemExpanded option. |
| OnItemHold(RazorBlock) | A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option. |
| OnItemHold(String) | A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option. |
| OnItemRendered(RazorBlock) | A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option. |
| OnItemRendered(String) | A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option. |
| OnItemSelectionChanged(RazorBlock) | A function that is executed when a single TreeView item is selected or selection is canceled. Mirrors the client-side onItemSelectionChanged option. |
| OnItemSelectionChanged(String) | A function that is executed when a single TreeView item is selected or selection is canceled. Mirrors the client-side onItemSelectionChanged option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnSelectAllValueChanged(RazorBlock) | A function that is executed when the 'Select All' check box value is changed. Applies only if showCheckBoxesMode is 'selectAll' and selectionMode is 'multiple'. Mirrors the client-side onSelectAllValueChanged option. |
| OnSelectAllValueChanged(String) | A function that is executed when the 'Select All' check box value is changed. Applies only if showCheckBoxesMode is 'selectAll' and selectionMode is 'multiple'. Mirrors the client-side onSelectAllValueChanged option. |
| OnSelectionChanged(RazorBlock) | A function that is executed when a TreeView item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| OnSelectionChanged(String) | A function that is executed when a TreeView item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| Option(String, Object) | Specifies an option by its name. |
| ParentIdExpr(JS) | Specifies the name of the data source item field for holding the parent key of the corresponding node. Mirrors the client-side parentIdExpr option. |
| ParentIdExpr(String) | Specifies the name of the data source item field for holding the parent key of the corresponding node. Mirrors the client-side parentIdExpr option. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| Render() | Inherited from WidgetBuilder. |
| RootValue(Object) | Specifies the parent ID value of the root item. Mirrors the client-side rootValue option. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| ScrollDirection(ScrollDirection) | A string value specifying available scrolling directions. Mirrors the client-side scrollDirection option. |
| SearchEditorOptions(Action<TextBoxBuilder>) | Configures the search panel. Mirrors the client-side searchEditorOptions object. |
| SearchEnabled(JS) | Mirrors the client-side searchEnabled option. |
| SearchEnabled(Boolean) | Mirrors the client-side searchEnabled option. |
| SearchExpr(JS) | Specifies a data object's field name or an expression whose value is compared to the search string. Mirrors the client-side searchExpr option. |
| SearchExpr(IEnumerable<String>) | Specifies a data object's field name or an expression whose value is compared to the search string. Mirrors the client-side searchExpr option. |
| SearchExpr(String[]) | Specifies a data object's field name or an expression whose value is compared to the search string. Mirrors the client-side searchExpr option. |
| SearchMode(CollectionSearchMode) | Specifies a comparison operation used to search UI component items. Mirrors the client-side searchMode option. |
| SearchTimeout(JS) | Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. Mirrors the client-side searchTimeout option. |
| SearchTimeout(Double) | Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. Mirrors the client-side searchTimeout option. |
| SearchValue(JS) | Mirrors the client-side searchValue option. |
| SearchValue(String) | Mirrors the client-side searchValue option. |
| SelectAllText(JS) | Specifies the text displayed at the 'Select All' check box. Mirrors the client-side selectAllText option. |
| SelectAllText(String) | Specifies the text displayed at the 'Select All' check box. Mirrors the client-side selectAllText option. |
| SelectByClick(JS) | Specifies whether an item is selected if a user clicks it. Mirrors the client-side selectByClick option. |
| SelectByClick(Boolean) | Specifies whether an item is selected if a user clicks it. Mirrors the client-side selectByClick option. |
| SelectedExpr(JS) | Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected. Mirrors the client-side selectedExpr option. |
| SelectedExpr(String) | Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected. Mirrors the client-side selectedExpr option. |
| SelectionMode(NavSelectionMode) | Specifies item selection mode. Applies only if selection is enabled. Mirrors the client-side selectionMode option. |
| SelectNodesRecursive(JS) | Specifies whether all child nodes should be selected when their parent node is selected. Applies only if the selectionMode is 'multiple'. Mirrors the client-side selectNodesRecursive option. |
| SelectNodesRecursive(Boolean) | Specifies whether all child nodes should be selected when their parent node is selected. Applies only if the selectionMode is 'multiple'. Mirrors the client-side selectNodesRecursive option. |
| ShowCheckBoxesMode(TreeViewCheckBoxMode) | Specifies the checkbox display mode. Mirrors the client-side showCheckBoxesMode option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| UseNativeScrolling(JS) | |
| UseNativeScrolling(Boolean) | |
| VirtualModeEnabled(JS) | Enables the virtual mode in which nodes are loaded on demand. Use it to enhance the performance on large datasets. Mirrors the client-side virtualModeEnabled option. |
| VirtualModeEnabled(Boolean) | Enables the virtual mode in which nodes are loaded on demand. Use it to enhance the performance on large datasets. Mirrors the client-side virtualModeEnabled option. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
See Also