Click here to Skip to main content
6,821,293 members and growing! (22,645 online)
Email Password   helpLost your password?
Web Development » ASP.NET Controls » General License: The Code Project Open License (CPOL)

ASTreeView - A Free TreeView Control for ASP.NET

By JIN Weijie

A full functional treeview control for ASP.NET, including drag and drop, Ajax loading, context menu, dropdown treeview.
C#, Javascript, Windows, ASP.NET, Ajax, Dev
Revision:10 (See All)
Posted:14 Oct 2009
Updated:6 Jan 2010
Views:23,566
Bookmarked:127 times
printPrint   add Share
      Discuss Discuss   Broken Article?Report  
62 votes for this article.
Popularity: 8.55 Rating: 4.77 out of 5
1 vote, 1.6%
1

2
3 votes, 4.8%
3
3 votes, 4.8%
4
55 votes, 88.7%
5

Introduction

ASTreeView is a powerful treeview control for ASP.NET with drag drop, Ajax loading, context menu, XML import/export, checkbox, selection, adding/editing/deleting nodes with Ajax.

Background

ASTreeView is developed on .NET Framework 2.0. The demo project is a Visual Studio 2005 project. ASTreeView is compatible with ASP.NET 2.0 and above.

ASTreeView is FREE! That means you can use it anywhere!

I host the project on Google Code: please download the assembly and the demo, check out the demo, and use ASTreeView in your project!

Updated

I registered a domain name for astreeview: http://www.astreeview.com.

Using the Code

Here are functionalities ASTreeView supports:

1. Drag & Drop

User can drag & drop nodes within the tree or even among trees!

astreeview_intro_1

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo1.aspx.

 <ct:ASTreeView ID="astvMyTree" 
	runat="server"
	BasePath="~/Javascript/astreeview/"
	DataTableRootNodeValue="0"
	EnableRoot="false" 
	EnableNodeSelection="false" 
	EnableCheckbox="true" 
	EnableDragDrop="true" 
	EnableTreeLines="true"
	EnableNodeIcon="true"
	EnableCustomizedNodeIcon="true"
	EnableContextMenu="true"
	EnableDebugMode="false"
	EnableContextMenuAdd="false" />  
In Code Behind
protected void btnToggleDragDrop_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableDragDrop = !this.astvMyTree.EnableDragDrop;
}
 
protected void btnToggleTreeLines_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableTreeLines = !this.astvMyTree.EnableTreeLines;
}
 
protected void btnToggleNodeIcon_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableNodeIcon = !this.astvMyTree.EnableNodeIcon;
}
 
protected void btnToggleCheckbox_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableCheckbox = !this.astvMyTree.EnableCheckbox;
}
 
protected void btnToggleDefaultNodeIcon_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableCustomizedNodeIcon = 
			!this.astvMyTree.EnableCustomizedNodeIcon;
}
 
protected void btnToggleContextMenu_Click( object sender, EventArgs e )
{
	this.astvMyTree.EnableContextMenu = !this.astvMyTree.EnableContextMenu;
} 

2. Tree Lines

Enable/Disable tree line is available.

astreeview_intro_2

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo1.aspx.

3. Tree Node Icons

The developer can specific customized icon for each node, use default node icon, or, disable node icon.

astreeview_intro_3

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo1.aspx.

4. Checkbox

Three-state (checked, unchecked, half-checked) checkbox is available.

astreeview_intro_4

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo1.aspx.

5. Tree Node Context Menu

A user can use context menu to edit/delete node by right clicking the node. Ajax edit/delete is supported.

astreeview_intro_5

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo3.aspx.

6. Multi-data Source Supported

A developer can bind different types of data source (currently astreeview supports datatable and XML datasource). Or developer can create ASTreeViewNode and append to the tree in the code.

XML

astreeview_intro_6

DataTable

astreeview_intro_6-2

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo4.aspx.

7. Server-side Event Supported

OnSelectedNodeChanged and OnCheckedNodeChanged are available.

astreeview_intro_7

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo2.aspx.

Configuration
  <ct:ASTreeView ID="astvMyTree" 
	runat="server"
	BasePath="~/Javascript/astreeview/"
	DataTableRootNodeValue="0"
	EnableRoot="false" 
	EnableNodeSelection="true" 
	EnableCheckbox="true" 
	EnableDragDrop="false" 
	EnableTreeLines="true"
	EnableNodeIcon="true"
	EnableCustomizedNodeIcon="false"
	AutoPostBack="true"
	EnableDebugMode="false"
	EnableContextMenu="false"
	OnOnCheckedNodeChanged="astvMyTree_OnCheckedNodeChanged" 
	OnOnSelectedNodeChanged="astvMyTree_OnSelectedNodeChanged" />
In Code Behind
protected void astvMyTree_OnCheckedNodeChanged
	( object src, ASTreeViewNodeCheckedEventArgs e )
{
	string toConsole = string.Format( ">>OnCheckedNodeChanged checked: 
		text:{0} value:{1} state:{2}", e.NodeText, e.NodeValue, 
		e.CheckedState.ToString() );
	this.divConsole.InnerHtml += ( toConsole + "<br />" );
}
 
protected void astvMyTree_OnSelectedNodeChanged( object src, 
				ASTreeViewNodeSelectedEventArgs e )
{
	string toConsole = string.Format( ">>OnSelectedNodeChanged selected: 
		text:{0} value:{1}", e.NodeText, e.NodeValue );
	this.divConsole.InnerHtml += ( toConsole + "<br />" );
}
 
protected void btnGetSelectedNode_Click( object sender, EventArgs e )
{
	string toConsole = string.Empty;
 
	ASTreeViewNode selectedNode = astvMyTree.GetSelectedNode();
	if( selectedNode == null )
		toConsole = ">>no node selected.";
	else
		toConsole = string.Format( ">>node selected: text:{0} value:{1}", 
			selectedNode.NodeText, selectedNode.NodeValue );
 
	this.divConsole.InnerHtml += ( toConsole + "<br />" );
}
 
protected void btnGetCheckedNodes_Click( object sender, EventArgs e )
{
	List<ASTreeViewNode> checkedNodes = this.astvMyTree.GetCheckedNodes
			( cbIncludeHalfChecked.Checked );
	StringBuilder sb = new StringBuilder();
 
	foreach( ASTreeViewNode node in checkedNodes )
		sb.Append( string.Format( "[text:{0}, value:{1}]<br />", 
			node.NodeText, node.NodeValue ) );
 
	this.divConsole.InnerHtml += ( string.Format( ">>nodes checked: 
		<div style='padding-left:20px;'>{0}</div>", sb.ToString() ) );
} 

8. Ajax Nodes Loading Supported

Having thousands of nodes? No problem, ASTreeView supports loading nodes using Ajax.

astreeview_intro_8

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo5.aspx.

Configuration
<ct:ASTreeView ID="astvMyTree" 
	runat="server"
	BasePath="~/Javascript/astreeview/"
	DataTableRootNodeValue="0"
	EnableRoot="false" 
	EnableNodeSelection="true" 
	EnableCheckbox="true" 
	EnableDragDrop="false" 
	EnableTreeLines="true"
	EnableNodeIcon="true"
	EnableCustomizedNodeIcon="false"
	EnableContextMenu="true"
	EnableDebugMode="false" 
	EnableAjaxOnEditDelete="true"
	AddNodeProvider="~/ASTreeViewDemo5.aspx"
	AdditionalAddRequestParameters="{'t2':'ajaxAdd'}"
	EditNodeProvider="~/ASTreeViewRenameNodeHandler.aspx"
	DeleteNodeProvider="~/ASTreeViewDeleteNodeProvider.aspx"
	LoadNodesProvider="~/ASTreeViewDemo5.aspx"
	AdditionalLoadNodesRequestParameters="{'t1':'ajaxLoad'}"/> 
In Code Behind
protected override void Render( HtmlTextWriter writer )
{
	if( Request.QueryString["t1"] == "ajaxLoad" )
	{
		string virtualParentKey = Request.QueryString["virtualParentKey"];
 
		string para = string.Empty;// "= 1";
		if( virtualParentKey == null )
			para = " is NULL";
		else
			para = "=" + virtualParentKey;
 
		string sql = @"SELECT p1.[ProductID] as 
		    ProductID, p1.[ProductName] as ProductName, 
		    p1.[ParentID] as ParentID, p3.childNodesCount as ChildNodesCount
FROM [Products] p1
LEFT OUTER JOIN 
(
	SELECT COUNT(*) AS childNodesCount , p2.[ParentID] AS pId 
	FROM [Products] p2
	GROUP BY p2.[ParentID]
) p3
ON p1.[ProductID] = p3.pId
WHERE p1.[ParentID] " + para;
 
DataTable dt = OleDbHelper.ExecuteDataset( base.NorthWindConnectionString, 
	CommandType.Text, sql ).Tables[0];
 
ASTreeViewNode root = new ASTreeViewNode( "root" );
 
foreach( DataRow dr in dt.Rows )
{
	string productName = dr["ProductName"].ToString();
	string productId = dr["ProductID"].ToString();
	string parentId = dr["ParentID"].ToString();
	int childNodesCount = 0;
	if( !string.IsNullOrEmpty( dr["ChildNodesCount"].ToString() ) )
		childNodesCount = int.Parse( dr["ChildNodesCount"].ToString() );
 
	ASTreeViewLinkNode node = new ASTreeViewLinkNode( productName, productId );
	node.VirtualNodesCount = childNodesCount;
	node.VirtualParentKey = productId;
	node.IsVirtualNode = childNodesCount > 0;
	node.NavigateUrl = "#";
	node.AddtionalAttributes.Add( new KeyValuePair<string, string>
			( "onclick", "return false;" ) );
 
	root.AppendChild( node );
}
 
HtmlGenericControl ulRoot = new HtmlGenericControl( "ul" );
astvMyTree.TreeViewHelper.ConvertTree( ulRoot, root, false );
foreach( Control c in ulRoot.Controls )
	c.RenderControl( writer );
}
else if( Request.QueryString["t2"] == "ajaxAdd" )
{
	string addNodeText = Request.QueryString["addNodeText"];
	int parentNodeValue = int.Parse( Request.QueryString["parentNodeValue"] );
 
	string maxSql = "select max( productId ) from products";
	int max = (int)OleDbHelper.ExecuteScalar
		( base.NorthWindConnectionString, CommandType.Text, maxSql );
	int newId = max + 1;
 
	string sql = string.Format( @"INSERT INTO products
	( productid, Discontinued, productname, parentid ) values( {0} ,0, '{1}', {2})"
	, max + 1, addNodeText.Replace( "'", "''" ), parentNodeValue );
 
	int i = OleDbHelper.ExecuteNonQuery
		( base.NorthWindConnectionString, CommandType.Text, sql );
 
	ASTreeViewNode root = new ASTreeViewNode( "root" );
 
	ASTreeViewLinkNode node = new ASTreeViewLinkNode
				( addNodeText, newId.ToString() );
	node.NavigateUrl = "#";
	node.AddtionalAttributes.Add( new KeyValuePair<string, 
			string>( "onclick", "return false;" ) );
 
	root.AppendChild( node );
 
	HtmlGenericControl ulRoot = new HtmlGenericControl( "ul" );
	astvMyTree.TreeViewHelper.ConvertTree( ulRoot, root, false );
	foreach( Control c in ulRoot.Controls )
		c.RenderControl( writer );
}
else
	base.Render( writer );			
} 

9. Multi-type Tree Node

A tree node can be a hyper-link or LinkButton to perform postback.

astreeview_intro_9

See live demo

10. ASDropDownTree

ASDropDownTree inherits ASTreeView, looks like a DropDownList, multi-selection and single-selection are available by the control's configuration.

astreeview_intro_10

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo6.aspx.

11. Drag & Drop Between (or Even Among) Trees

Nodes can be dragged and dropped across trees.

astreeview_intro_11

See live demo: http://www.astreeview.com/ASTreeViewDemo/ASTreeViewDemo7.aspx.

12. Extending ContextMenu

Now it is possible to add your customized ContextMenu Items to the menu. A screenshot:

image

To add your customized menu, it’s easy:

/// <summary>
/// initial controls, bind you events etc. here
/// </summary>
private void InitializeComponent()
{
    this.astvMyTree.ContextMenu.MenuItems.Add( new ASContextMenuItem( 
        "Custom Menu 1", "alert('current value:' + " 
        + this.astvMyTree.ContextMenuClientID
        + ".getSelectedItem().parentNode.getAttribute('treeNodeValue')" 
        + ");return false;", "otherevent" ) );
 
    this.astvMyTree.ContextMenu.MenuItems.Add( new ASContextMenuItem( 
        "Custom Menu 2", "alert('current text:' + " 
        + this.astvMyTree.ContextMenuClientID 
        + ".getSelectedItem().innerHTML" 
        + ");return false;", "otherevent" ) );
}

Online demo: http://www.astreeview.com/astreeviewdemo/ASTreeViewDemo3.aspx.

13. Extending ContextMenu

In version 1.3.0, the end user can open the folder by clicking on the node text. It is useful when only the leaf nodes are clickable, for example, bookmarks.

image

To enable this feature, just set the “EnableParentNodeExpand” property of ASTreeView.

14. Customize Node with HTML

NodeText can be HTML:

 this.astvMyTree.RootNode
.AppendChild( new ASTreeViewLinkNode
	( "Accor <a href='http://www.astreeview.com' target='_blank'>see demo</a>"
, "Accor"
, "http://www.accor.com", "_self", "Goto Accor", "~/Images/demoIcons/accor.gif" )
	.AppendChild( new ASTreeViewLinkNode( "Accor Services", 
	"Accor Services", http://www.accorservices.com, 
	"_self", "Goto Accor Services", "~/Images/demoIcons/accorservices.gif" ) )
	.AppendChild( new ASTreeViewLinkNode( "Accor Hospitality", 
	"Accor Hospitality", "http://www.accorhotels.com", "_self", 
	"Goto Accor Hospitality", "~/Images/demoIcons/accorhospitality.gif" ) )
); 

15. Themes

ASTreeView now supports themes! Developer can easily create his own theme for the treeview. Check out the demo.

Screenshot:

image

16. Right-To-Left support

ASTreeView now supports rtl display, thank Mojtaba Vali for the suggestion! Also check out the demo.

image

17. HTML as TreeNodeText Supported

In the new version, you may use HTML as tree node text, not only plain text.

image

18. Multiline Edit Mode Supported

Set the EnableMultiLineEdit property to enable this feature, the default is false.

image

19. Drag and Drop Complete Event Now is Available.

I added a new client side event after drag and drop. to use:

   <script type="text/javascript">
        //parameter must be "elem"
        function dndHandler( elem ){
            document.getElementById( "<%=divConsole.ClientID %>" ).innerHTML 
                       += ( ">>node dragged:" 
                            + elem.getAttribute("treeNodeValue") 
                            + "<br />" );
        }
    </script>    

and then set the OnNodeDragAndDropCompleteScript="dndHandler( elem )", visit demo.

Screenshot:

image

20. New Property for ASTreeViewNode – EnableChildren

Set this property to false can disable dragging other nodes to the current node as child nodes. Please refer to sample 1 to see the effect.

21. Virtical Drag and Drop Nodes

If you use ASTreeView as a list, you can set EnableHorizontalLock to true , then the end user can only move the nodes up and down, not left nor right.

Screenshot:

image

22. Fix Drag and Drop depth

If you want the end user just move the node within the same level as its original level, you may set the property EnableFixedDepthDragDrop=true, then the nodes can only be drag and drop to the same level as its original level, visit online demo.

23. Add OnNodeDragAndDropStartScript Event

A new event OnNodeDragAndDropStartScript is now available for developers to execute some js when the end user start to drag nodes. Here’s a usage sample:

add a property for astreeview:

OnNodeDragAndDropStartScript="dndStartHandler( elem )"

the js function to handle start drag drop:

//parameter must be "elem" 
    
functiondndStartHandler( elem ){   
    document.getElementById("").innerHTML   
    += (">>drag started. [Node]"+ elem.getAttribute("treeNodeValue")   
    +" [Parent]:"+ elem.parentNode.parentNode.getAttribute("treeNodeValue")   
    +"
"); 
    
} 

Points of Interest

I spent two or three months in development, and the ASTreeView is finally finished. Now I would like to introduce it to you. Your feedback is appreciated!

History

The current version of ASTreeView is 1.4.0, visit for details.

In the release 1.4.0, several new features are added:

  1. Virtical Drag and Drop Nodes
  2. Fix Drag and Drop depth
  3. Add OnNodeDragAndDropStartScript Event
  4. Several bugs fixed.

In the release 1.3.0, several new features are added:

  1. Themes
  2. Right-To-Left support
  3. HTML as TreeNodeText supported
  4. Support escape edit/add input
  5. Multiline Edit Mode supported
  6. Drag and drop complete event now is available
  7. New property for ASTreeViewNode EnableChildren

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

JIN Weijie


Member
ASTreeView, the best FREE treeview control for ASP.NET.
Occupation: Software Developer (Senior)
Company: GEEKEES.COM
Location: China China

Other popular ASP.NET Controls articles:

Article Top
You must Sign In to use this message board.
FAQ FAQ 
 
Noise Tolerance  Layout  Per page   
 Msgs 1 to 25 of 196 (Total in Forum: 196) (Refresh)FirstPrevNext
GeneralHow to clear nodes Pinmembermindweaver4:33 8 Feb '10  
GeneralRe: How to clear nodes PinmemberJIN Weijie4:52 8 Feb '10  
GeneralRe: How to clear nodes Pinmembermindweaver5:06 8 Feb '10  
GeneralRe: How to clear nodes PinmemberJIN Weijie5:18 8 Feb '10  
GeneralRe: How to clear nodes Pinmembermindweaver5:33 8 Feb '10  
GeneralRe: How to clear nodes PinmemberJIN Weijie5:34 8 Feb '10  
GeneralRe: How to clear nodes Pinmembermindweaver5:53 8 Feb '10  
GeneralRe: How to clear nodes PinmemberJIN Weijie5:57 8 Feb '10  
GeneralRe: How to clear nodes Pinmembermindweaver6:00 8 Feb '10  
GeneralRe: How to clear nodes PinmemberJIN Weijie17hrs 27mins ago 
GeneralRe: How to clear nodes PinmemberJIN Weijie1 hr 42mins ago 
Generalnew vesrion not in code project why??????????????? Pinmemberaa.azizkhani6:37 6 Feb '10  
GeneralRe: new vesrion not in code project why??????????????? PinmemberJIN Weijie15:24 6 Feb '10  
GeneralRe: new vesrion not in code project why??????????????? Pinmemberaa.azizkhani21hrs 36mins ago 
GeneralRe: new vesrion not in code project why??????????????? PinmemberJIN Weijie1 hr 43mins ago 
GeneralNode index after drag&drop Pinmembercristi82gt4:14 1 Feb '10  
GeneralRe: Node index after drag&drop PinmemberJIN Weijie15:27 1 Feb '10  
Generalclient side HREF handling Pinmemberehudl0:22 25 Jan '10  
GeneralRe: client side HREF handling PinmemberJIN Weijie2:38 25 Jan '10  
GeneralRe: client side HREF handling Pinmemberehudl3:59 25 Jan '10  
GeneralRe: client side HREF handling PinmemberJIN Weijie4:33 25 Jan '10  
GeneralRe: client side HREF handling Pinmemberehudl4:43 25 Jan '10  
GeneralRe: client side HREF handling PinmemberJIN Weijie4:49 25 Jan '10  
GeneralRe: client side HREF handling Pinmemberehudl5:03 25 Jan '10  
GeneralRe: client side HREF handling PinmemberJIN Weijie5:06 25 Jan '10  

General General    News News    Question Question    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads.

PermaLink | Privacy | Terms of Use
Last Updated: 6 Jan 2010
Editor: Sean Ewington
Copyright 2009 by JIN Weijie
Everything else Copyright © CodeProject, 1999-2010
Web17 | Advertise on the Code Project