IHierarchicalEnumerable.GetHierarchyData Method (Object)


Returns a hierarchical data item for the specified enumerated item.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

IHierarchyData GetHierarchyData(
	object enumeratedItem


Type: System.Object

The Object for which to return an IHierarchyData.

Return Value

Type: System.Web.UI.IHierarchyData

An IHierarchyData instance that represents the Object passed to the GetHierarchyData method.

Typically, clients that use IHierarchicalEnumerable collections retrieve an IEnumerator object by calling the GetEnumerator method, then iterate through the enumeration and call the GetHierarchyData method on each enumerated item to retrieve an IHierarchyData object.

The following code example demonstrates how an ASP.NET hierarchical data-bound control uses an IHierarchyData object in a recursive data-binding method. The items in an IHierarchicalEnumerable object are enumerated, and for each an IHierarchyData object is retrieved using the GetHierarchyData method. Finally, the HasChildren property is checked to determine whether recursion is necessary. This code example is part of a larger example provided for the HierarchicalDataBoundControl class.

private void RecurseDataBindInternal(TreeNode node, 
    IHierarchicalEnumerable enumerable, int depth) {                                    

    foreach(object item in enumerable) {
        IHierarchyData data = enumerable.GetHierarchyData(item);

        if (null != data) {
            // Create an object that represents the bound data
            // to the control.
            TreeNode newNode = new TreeNode();
            RootViewNode rvnode = new RootViewNode();

            rvnode.Node = newNode;
            rvnode.Depth = depth;

            // The dataItem is not just a string, but potentially
            // an XML node or some other container. 
            // If DataTextField is set, use it to determine which 
            // field to render. Otherwise, use the first field.                    
            if (DataTextField.Length > 0) {
                newNode.Text = DataBinder.GetPropertyValue
                    (data, DataTextField, null);
            else {
                PropertyDescriptorCollection props = 

                // Set the "default" value of the node.
                newNode.Text = String.Empty;                        

                // Set the true data-bound value of the TextBox,
                // if possible.
                if (props.Count >= 1) {                        
                    if (null != props[0].GetValue(data)) {
                        newNode.Text = 


            if (data.HasChildren) {
                IHierarchicalEnumerable newEnumerable = 
                if (newEnumerable != null) {                            
                        newEnumerable, depth+1 );

            if ( _maxDepth < depth) _maxDepth = depth;


.NET Framework
Available since 2.0
Return to top