Back to Devexpress

TreeListNode Class

aspnet-devexpress-dot-web-dot-aspxtreelist-ae287c4d.md

latest7.3 KB
Original Source

TreeListNode Class

Represents a node displayed within the ASPxTreeList control.

Namespace : DevExpress.Web.ASPxTreeList

Assembly : DevExpress.Web.ASPxTreeList.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
public class TreeListNode :
    IValueProvider
vb
Public Class TreeListNode
    Implements IValueProvider

The following members return TreeListNode objects:

Show 17 links

Remarks

The ASPxTreeList is a data visualization control that displays information as a tree. Nodes represent records from the associated data source.

The TreeListNode represents a single node. The TreeListNode.Key property specifies a node’s key value that uniquely identifies the node within the ASPxTreeList. The TreeListNode.ChildNodes property provides access to the collection of child nodes. The TreeListNode.ParentNode property returns the parent node.

The TreeListNode.Selected and TreeListNode.Expanded properties specify whether the node is selected or expanded, respectively.

Example

This example shows how to create a simple tree when the ASPxTreeList functions in unbound mode. New nodes are created and added to the ASPxTreeList via the ASPxTreeList.AppendNode method.

Columns can be created at design time or in code. For detailed information, see Creating Columns and Binding Them to Data Fields.

The image below shows the result:

csharp
using DevExpress.Web.ASPxTreeList;

protected void Page_Load(object sender, EventArgs e) {
    CreateTree();
}

void CreateTree() {
    TreeListNode parentNode = CreateNodeCore(0, "<b>Local Folders</b>", null);
    CreateNodeCore(1, "Inbox", parentNode);
    CreateNodeCore(2, "Outbox", parentNode);
    CreateNodeCore(3, "Sent Items", parentNode);
    CreateNodeCore(4, "Deleted Items", parentNode);
    TreeListNode searchFolders = CreateNodeCore(5, "<b>Search Folders</b>", null);
    CreateNodeCore(6, "Categorized Mail", searchFolders);
    CreateNodeCore(7, "Large Mail", searchFolders);
}

TreeListNode CreateNodeCore(int key, string text, TreeListNode parentNode) {
    TreeListNode node = ASPxTreeList1.AppendNode(key, parentNode);
    node["Folder"] = text;
    return node;
}
vb
Imports DevExpress.Web.ASPxTreeList

Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
    CreateTree()
End Sub

Sub CreateTree()
    Dim parentNode As TreeListNode = CreateNodeCore(0, "<b>Local Folders</b>", Nothing)
    CreateNodeCore(1, "Inbox", parentNode)
    CreateNodeCore(2, "Outbox", parentNode)
    CreateNodeCore(3, "Sent Items", parentNode)
    CreateNodeCore(4, "Deleted Items", parentNode)
    Dim searchFolders As TreeListNode = CreateNodeCore(5, "<b>Search Folders</b>", Nothing)
    CreateNodeCore(6, "Categorized Mail", searchFolders)
    CreateNodeCore(7, "Large Mail", searchFolders)
End Sub

Function CreateNodeCore(ByVal key As Integer, ByVal nodeText As String,_
ByVal parentNode As TreeListNode) As TreeListNode
    Dim node As TreeListNode = ASPxTreeList1.AppendNode(key, parentNode)
    node("Folder") = nodeText
    Return node
End Function
aspx
<dx:ASPxTreeList ID="ASPxTreeList1" runat="server" AutoGenerateColumns="False"
    Width="300px">
    <Columns>
        <dx:TreeListTextColumn FieldName="Folder" VisibleIndex="0">
            <PropertiesTextEdit EncodeHtml="False">
            </PropertiesTextEdit>
        </dx:TreeListTextColumn>
    </Columns>
</dx:ASPxTreeList>

Inheritance

Object TreeListNode MVCxTreeListNode

See Also

TreeListNode Members

Tree List

DevExpress.Web.ASPxTreeList Namespace