ASPxClientTreeView.GetNodeByName(name) Method

Returns a node specified by its name.

Declaration

GetNodeByName(
    name: string
): ASPxClientTreeViewNode

Parameters

Name	Type	Description
name	string	A string value specifying the name of the node.

Returns

Type	Description
ASPxClientTreeViewNode	An ASPxClientTreeViewNode object that represents the node with the specified name.

Remarks

An ASPxTreeView control’s client-side functionality allows an individual node to be accessed programmatically. The GetNodeByName method gets a client node object specified by its name. A node’s name is defined by the Name property.

This method searches the specified node amongst all nodes contained by the ASPxTreeView control (throughout all nesting levels). Note that if an invalid name is passed via the parameter, this method returns null.

In order to access a particular ASPxTreeView node’s child specified by its name, the ASPxTreeView node’s ASPxClientTreeViewNode.GetNodeByName method can be used.

Example

The code below selects a node with the specified Name property value (“MyDocuments”).

JS

var node = treeview.GetNodeByName('MyDocuments');
treeview.SetSelectedNode(node);

ASPX

<dx:ASPxTreeView ID="ASPxTreeView1" runat="server" ClientInstanceName="treeview" DataSourceID="XmlDataSource1">
</dx:ASPxTreeView>