Introduction
Knowledge Base
API Reference / Client-side / Telerik.Web.UI.RadTreeNode
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Telerik.Web.UI.RadTreeNode

Class

Definition

Namespace:Telerik.Web.UI

Inheritance: Telerik.Web.UI.ControlItemTelerik.Web.UI.RadTreeNode

Methods

bindTemplate

Evaluates the template against the Node's data item and applies it.

JS
bindTemplate(): void

check

Marks the checkbox for a Node

JS
check(): void

clone

Clones the node with or without the child-nodes (with respect to the boolean parameter cloneChildren).

JS
clone(Boolean cloneChildren): Telerik.Web.UI.RadTreeNode
Parameters:cloneChildrenBoolean

Determines whether the child nodes should be cloned.

Returns:

Telerik.Web.UI.RadTreeNode

The cloned node.

collapse

Collapses a Node

JS
collapse(): void

disable

Disables a Node

JS
disable(): void

enable

Enables a Node

JS
enable(): void

endEdit

Takes the Node out of editing mode.

JS
endEdit(): void

expand

Expands a Node

JS
expand(): void

get_allNodes

Returns an array of all the child Nodes of this node.

JS
get_allNodes(): Telerik.Web.UI.RadTreeNode[]
Returns:

Telerik.Web.UI.RadTreeNode[]

Returns an array of all the child Nodes of this node.

get_allowDrag

True, if dragging is allowed, false otherwise.

JS
get_allowDrag(): Boolean
Returns:

Boolean

get_allowDrop

True, if dropping is allowed, false otherwise.

JS
get_allowDrop(): Boolean
Returns:

Boolean

get_allowEdit

True, if Node edit is allowed, false, otherwise.

JS
get_allowEdit(): Boolean
Returns:

Boolean

get_attributes

Returns a Collection of all custom attributes set to the Node.

JS
get_attributes(): Object
Returns:

Object

get_category

Gets the category of the Node.

JS
get_category(): String
Returns:

String

get_checkable

Returns the checkability of the Node

JS
get_checkable(): Boolean
Returns:

Boolean

true if the node can be checked

get_checkBoxElement

Gets the DOM Element of the checkbox.

JS
get_checkBoxElement(): Element
Returns:

Element

DOM Element for the checkbox.

get_checked

Gets the checked state of a Node. The Node is checked if get_checked() returns true.

JS
get_checked(): Boolean
Returns:

Boolean

get_checkState

Returns the current check state of a node. It can be one of the following:Telerik.Web.UI.TreeNodeCheckState.Unchecked, Telerik.Web.UI.TreeNodeCheckState.Checked or Telerik.Web.UI.TreeNodeCheckState.Indeterminate

JS
get_checkState(): Telerik.Web.UI.TreeNodeCheckState
Returns:

Telerik.Web.UI.TreeNodeCheckState

get_childListElement

Returns the DOM element for the list of the child Nodes. Null if there are no child Nodes.

JS
get_childListElement(): Element
Returns:

Element

DOM element for the child nodes list

get_clientTemplate

Returns the value of the Node's ClientTemplate property.

JS
get_clientTemplate(): void

get_contentCssClass

Returns the value of ContentCssClass property of the Node

JS
get_contentCssClass(): String
Returns:

String

get_contentElement

JS
get_contentElement(): void

get_contextMenu

Returns the context menu object (if any).

JS
get_contextMenu(): Telerik.Web.UI.RadMenu
Returns:

Telerik.Web.UI.RadMenu

get_contextMenuID

Returns the ID of the Context Menu assigned to the Node.

JS
get_contextMenuID(): String
Returns:

String

get_cssClass

Returns the name of the CSS class applied to the Node.

JS
get_cssClass(): String
Returns:

String

get_disabledCssClass

Returns the name of the CSS class applied to the Node when disabled.

JS
get_disabledCssClass(): String
Returns:

String

get_disabledImageUrl

Returns the path to the image displayed next to the Node when disabled.

JS
get_disabledImageUrl(): String
Returns:

String

get_element

Returns the DOM element for a Node.

JS
get_element(): Element
Returns:

Element

get_enableContextMenu

True if the Context Menus are enabled,False otherwise.

JS
get_enableContextMenu(): Boolean
Returns:

Boolean

get_enabled

Gets the enabled state of the Node. The Node is enabled if get_enabled() returns true.

JS
get_enabled(): Object
Returns:

Object

get_expanded

Gets the expanded/collapsed state of a Node. The Node is expanded if get_expanded() returns true.

JS
get_expanded(): Boolean
Returns:

Boolean

get_expandedImageUrl

Returns the path to the image displayed next to the Node when expanded.

JS
get_expandedImageUrl(): String
Returns:

String

get_expandMode

Returns the ExpandMode of the Node. ExpandMode can be: 0 - ExpandMode.ClientSide; 1 - ExpandMode.ServerSide; 2 - ExpandMode.ServerSideCallBack; 3 - ExpandMode.WebService;

JS
get_expandMode(): Number
Returns:

Number

Int

get_hoveredCssClass

Returns the name of the CSS class applied to the Node when hovered.

JS
get_hoveredCssClass(): String
Returns:

String

get_hoveredImageUrl

Returns the path to the image displayed next to the Node when hovered.

JS
get_hoveredImageUrl(): String
Returns:

String

get_imageElement

Gets the DOM Element of the image set to the node. Note: Images are set using the RadTreeView ImageUrl property.

JS
get_imageElement(): Element
Returns:

Element

DOM Element for the image.

get_imageUrl

Returns the path to the image displayed next to the Node.

JS
get_imageUrl(): String
Returns:

String

get_index

Returns the index of the node in the nodes collection of its parent.

JS
get_index(): Object
Returns:

Object

get_inputElement

Returns the DOM element for the input when the Node is in Edit Mode

JS
get_inputElement(): Element
Returns:

Element

DOM Element

get_isEnabled

Returns true if both the Node and the tree are enabled. If one of them is disabled, the get_isEnabled returns false.

JS
get_isEnabled(): Object
Returns:

Object

get_lastChild

JS
get_lastChild(): void

get_lastVisibleChild

JS
get_lastVisibleChild(): void

get_level

Gets the Level of the Node in the TreeView structure. Root Nodes are at level 0, their children Nodes - at 1 and so on.

JS
get_level(): Number
Returns:

Number

get_linkElement

Gets the DOM element for the link of the Node when NavigateUrl is set

JS
get_linkElement(): Element
Returns:

Element

DOM element

get_loadingStatusElement

Returns the DOM element representing loading status of the Node.

JS
get_loadingStatusElement(): Element
Returns:

Element

DOM Element

get_navigateUrl

Returns the URL of the Node(the href attribute of the link). Null if the NavigateUrl server property is not set.

JS
get_navigateUrl(): String
Returns:

String

String

get_nextNode

Gets an instance of the next sibling of a Node.

JS
get_nextNode(): Telerik.Web.UI.RadTreeNode
Returns:

Telerik.Web.UI.RadTreeNode

get_nextVisibleNode

JS
get_nextVisibleNode(): void

get_nodeData

JS
get_nodeData(): void

get_nodes

Returns the RadTreeNodeCollection of a Node.

JS
get_nodes(): Telerik.Web.UI.RadTreeNodeCollection
Returns:

Telerik.Web.UI.RadTreeNodeCollection

get_postBack

True if postback is enabled, false otherwise.

JS
get_postBack(): Boolean
Returns:

Boolean

get_previousNode

Gets an instance of the previous sibling of a Node.

JS
get_previousNode(): Telerik.Web.UI.RadTreeNode
Returns:

Telerik.Web.UI.RadTreeNode

RadTreeNode

get_prevVisibleNode

JS
get_prevVisibleNode(): void

get_resolvedContextMenuID

JS
get_resolvedContextMenuID(): void

get_selected

Gets the selected state of a Node. Returns true if the Node is selected.

JS
get_selected(): Boolean
Returns:

Boolean

get_selectedCssClass

Returns the name of the CSS class applied to the Node when selected.

JS
get_selectedCssClass(): String
Returns:

String

get_selectedImageUrl

Returns the path to the image displayed next to the Node when selected.

JS
get_selectedImageUrl(): String
Returns:

String

get_target

Gets the target of the Node. If a target is not set, returns null.

JS
get_target(): String
Returns:

String

get_text

Retrieves the text for a Node.

JS
get_text(): String
Returns:

String

get_textElement

Gets the DOM Element of the text set to the Node. Note: Changes to the text element are not persisted across postbacks.;

JS
get_textElement(): Element
Returns:

Element

DOM Element for the text of the Node.

get_toggleElement

Returns the DOM element representing the toggle image. Null, if the Node has no child Nodes.

JS
get_toggleElement(): Element
Returns:

Element

DOM Element for the toggle image.

get_toolTip

Gets the ToolTip of the Node. If a ToolTip is not set, returns null.

JS
get_toolTip(): String
Returns:

String

get_treeView

Gets an instance to the parent RadTreeView.

JS
get_treeView(): Telerik.Web.UI.RadTreeView
Returns:

Telerik.Web.UI.RadTreeView

get_value

Gets the value of the Node.

JS
get_value(): Object
Returns:

Object

get_visible

True if the item is visible.

JS
get_visible(): Boolean
Returns:

Boolean

hideLoadingStatus

Hides the loading message.

JS
hideLoadingStatus(): void

highlight

Highlights a Node. Highlighted Nodes are visually emphasized.

JS
highlight(): void

scrollIntoView

Causes the Node to scroll into view, aligning the Node to the bottom of the TreeView area.

JS
scrollIntoView(): void

select

Selects a Node

JS
select(): void

set_allowDrag

Enables/Disables dragging.

JS
set_allowDrag(Boolean value): void
Parameters:valueBoolean

value

set_allowDrop

Enables/Disables dragging.

JS
set_allowDrop(Boolean value): void
Parameters:valueBoolean

value

set_allowEdit

Allows/Disallows Node editing.

JS
set_allowEdit(Boolean value): void
Parameters:valueBoolean

value

set_category

Sets the category of the Node.

JS
set_category(String value): void
Parameters:valueString

value

set_checkable

Enables/Disables the checkability of the Node.

JS
set_checkable(Boolean value): void
Parameters:valueBoolean

value

set_checked

Marks or unmarks the checkbox for a Node.

JS
set_checked(Boolean value): void
Parameters:valueBoolean

Boolean

set_clientTemplate

Sets the value of the Node's ClientTemplate property.

JS
set_clientTemplate(String value): void
Parameters:valueString

value

set_contentCssClass

Sets the value of ContentCssClass property of the Node

JS
set_contentCssClass(String value): void
Parameters:valueString

value

set_contextMenuID

Sets the ID of the Context menu to be assigned to the Node.

JS
set_contextMenuID(String contextMenuID): void
Parameters:contextMenuIDString

contextMenuID

set_cssClass

Sets the name of the CSS class to be applied to the Node.

JS
set_cssClass(String value): void
Parameters:valueString

value

set_disabledCssClass

Sets the name of the CSS class to be applied to the Node when disabled.

JS
set_disabledCssClass(String value): void
Parameters:valueString

value

set_disabledImageUrl

Sets the path to the image displayed next to the Node when disabled.

JS
set_disabledImageUrl(String value): void
Parameters:valueString

value

set_element

JS
set_element(Element value): void
Parameters:valueElement

Sets the DOM element of the node

set_enableContextMenu

Determines if the Context Menu should be enabled.

JS
set_enableContextMenu(Boolean value): void
Parameters:valueBoolean

value

set_enabled

Enables or disables a Node based on the boolean parameter passed in.

JS
set_enabled(Boolean value): void
Parameters:valueBoolean

value

set_expanded

Expands or collapses a Node.

JS
set_expanded(Boolean value): void
Parameters:valueBoolean

value

set_expandedImageUrl

Sets the path to the image displayed next to the Node when expanded.

JS
set_expandedImageUrl(String value): void
Parameters:valueString

value

set_expandMode

Sets the ExpandMode of the Node. ExpandMode can be: Telerik.Web.UI.TreeNodeExpandMode.ClientSide; Telerik.Web.UI.TreeNodeExpandMode.ServerSide; Telerik.Web.UI.TreeNodeExpandMode.ServerSideCallBack; Telerik.Web.UI.TreeNodeExpandMode.WebService;

JS
set_expandMode(Telerik.Web.UI.TreeNodeExpandMode value): void
Parameters:valueTelerik.Web.UI.TreeNodeExpandMode

value

set_hoveredCssClass

Sets the name of the CSS class to be applied to the Node when hovered.

JS
set_hoveredCssClass(String value): void
Parameters:valueString

value

set_hoveredImageUrl

Sets the path to the image displayed next to the Node when hovered.

JS
set_hoveredImageUrl(String value): void
Parameters:valueString

value

set_imageUrl

Sets the path to the image displayed next to the Node.

JS
set_imageUrl(String value): void
Parameters:valueString

value

set_navigateUrl

Sets the URL of the Node. Works only if the NavigateUrl property has been set at the server-side beforehand or if the Node is not added at the client-side.

JS
set_navigateUrl(String value): void
Parameters:valueString

value

set_postBack

Determines if the Node should postback.

JS
set_postBack(Boolean value): void
Parameters:valueBoolean

value

set_selected

Selects or unselects a Node based on the boolean parameter.

JS
set_selected(Boolean value): void
Parameters:valueBoolean

value

set_selectedCssClass

Sets the name of the CSS class to be applied to the Node when selected.

JS
set_selectedCssClass(String value): void
Parameters:valueString

value

set_selectedImageUrl

Sets the path to the image displayed next to the Node when selected.

JS
set_selectedImageUrl(String value): void
Parameters:valueString

value

set_target

Sets the target of the Node.

JS
set_target(String value): void
Parameters:valueString

value

set_text

Sets the text of the Node.

JS
set_text(String text): void
Parameters:textString

text

set_toolTip

Sets the ToolTip of the Node.

JS
set_toolTip(String value): void
Parameters:valueString

value

set_value

Sets the value of the Node.

JS
set_value(Object string): Object
Parameters:stringObjectReturns:

Object

set_visible

Set the visibility of a Node.

JS
set_visible(Boolean value): void
Parameters:valueBoolean

value

showLoadingStatus

Shows the loading message at the specified position. The available positions are: Telerik.Web.UI.TreeViewLoadingStatusPosition.BelowNodeTextTelerik.Web.UI.TreeViewLoadingStatusPosition.AfterNodeText Telerik.Web.UI.TreeViewLoadingStatusPosition.BeforeNodeText

JS
showLoadingStatus(String text, Telerik.Web.UI.TreeViewLoadingStatusPosition position): void
Parameters:textString

text

positionTelerik.Web.UI.TreeViewLoadingStatusPosition

position

startEdit

Allows the Node to be edited. This is equivalent to the user clicking the Node twice or pressing F2.

JS
startEdit(): void

toggle

Collapses an expanded Node or expands a collapsed Node.

JS
toggle(): void

uncheck

Unmarks the checkbox for a Node

JS
uncheck(): void

unhighlight

Un-highlights a Node

JS
unhighlight(): void

unselect

Unselects a Node

JS
unselect(): void
Not finding the help you need?
Contact Support