TreeNodeCollection Class

 

Represents a collection of TreeNode objects.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.Windows.Forms.TreeNodeCollection

public class TreeNodeCollection : IList, ICollection, IEnumerable

NameDescription
System_CAPS_pubpropertyCount

Gets the total number of TreeNode objects in the collection.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the collection is read-only.

System_CAPS_pubpropertyItem[Int32]

Gets or sets the TreeNode at the specified indexed location in the collection.

System_CAPS_pubpropertyItem[String]

Gets the tree node with the specified key from the collection.

NameDescription
System_CAPS_pubmethodAdd(String)

Adds a new tree node with the specified label text to the end of the current tree node collection.

System_CAPS_pubmethodAdd(String, String)

Creates a new tree node with the specified key and text, and adds it to the collection.

System_CAPS_pubmethodAdd(String, String, Int32)

Creates a tree node with the specified key, text, and image, and adds it to the collection.

System_CAPS_pubmethodAdd(String, String, Int32, Int32)

Creates a tree node with the specified key, text, and images, and adds it to the collection.

System_CAPS_pubmethodAdd(String, String, String)

Creates a tree node with the specified key, text, and image, and adds it to the collection.

System_CAPS_pubmethodAdd(String, String, String, String)

Creates a tree node with the specified key, text, and images, and adds it to the collection.

System_CAPS_pubmethodAdd(TreeNode)

Adds a previously created tree node to the end of the tree node collection.

System_CAPS_pubmethodAddRange(TreeNode[])

Adds an array of previously created tree nodes to the collection.

System_CAPS_pubmethodClear()

Removes all tree nodes from the collection.

System_CAPS_pubmethodContains(TreeNode)

Determines whether the specified tree node is a member of the collection.

System_CAPS_pubmethodContainsKey(String)

Determines whether the collection contains a tree node with the specified key.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies the entire collection into an existing array at a specified location within the array.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFind(String, Boolean)

Finds the tree nodes with specified key, optionally searching subnodes.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that can be used to iterate through the tree node collection.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIndexOf(TreeNode)

Returns the index of the specified tree node in the collection.

System_CAPS_pubmethodIndexOfKey(String)

Returns the index of the first occurrence of a tree node with the specified key.

System_CAPS_pubmethodInsert(Int32, String)

Creates a tree node with the specified text and inserts it at the specified index.

System_CAPS_pubmethodInsert(Int32, String, String)

Creates a tree node with the specified text and key, and inserts it into the collection.

System_CAPS_pubmethodInsert(Int32, String, String, Int32)

Creates a tree node with the specified key, text, and image, and inserts it into the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, String, String, Int32, Int32)

Creates a tree node with the specified key, text, and images, and inserts it into the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, String, String, String)

Creates a tree node with the specified key, text, and image, and inserts it into the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, String, String, String, String)

Creates a tree node with the specified key, text, and images, and inserts it into the collection at the specified index.

System_CAPS_pubmethodInsert(Int32, TreeNode)

Inserts an existing tree node into the tree node collection at the specified location.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemove(TreeNode)

Removes the specified tree node from the tree node collection.

System_CAPS_pubmethodRemoveAt(Int32)

Removes a tree node from the tree node collection at a specified index.

System_CAPS_pubmethodRemoveByKey(String)

Removes the tree node with the specified key from the collection.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Add(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds an object to the end of the tree node collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Contains(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the specified tree node is a member of the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.IndexOf(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the index of the specified tree node in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Insert(Int32, Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Inserts an existing tree node in the tree node collection at the specified location.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIList.Remove(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Removes the specified tree node from the tree node collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether access to the collection is synchronized (thread safe).

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an object that can be used to synchronize access to the collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.IsFixedSize

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the tree node collection has a fixed size.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIList.Item[Int32]

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the tree node at the specified index in the collection.

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

The Add, Remove, and RemoveAt methods enable you to add and remove individual tree nodes from the collection.

System_CAPS_noteNote

Enumerating the collection and removing nodes is not supported.

You can also use the AddRange or Clear methods to add or remove all the tree nodes from the collection.

Classes cannot inherit from the TreeNodeCollection class.

The following code example displays customer information in a TreeView control. The root tree nodes display customer names, and the child tree nodes display the order numbers assigned to each customer. In this example, 1,000 customers are displayed with 15 orders each. The repainting of the TreeView is suppressed by using the BeginUpdate and EndUpdate methods, and a wait Cursor is displayed while the TreeView creates and paints the TreeNode objects. This example requires that you have a Customer object that can hold a collection of Order objects. It also requires that you have created an instance of a TreeView control on a Form.


// The basic Customer class.
public class Customer : System.Object
{
   private string custName = "";
   protected ArrayList custOrders = new ArrayList();

   public Customer(string customername)
   {
      this.custName = customername;
   }

   public string CustomerName
   {      
      get{return this.custName;}
      set{this.custName = value;}
   }

   public ArrayList CustomerOrders 
   {
      get{return this.custOrders;}
   }

} // End Customer class 


// The basic customer Order class.
public class Order : System.Object
{
   private string ordID = "";

   public Order(string orderid)
   {
      this.ordID = orderid;
   }

   public string OrderID
   {      
      get{return this.ordID;}
      set{this.ordID = value;}
   }

} // End Order class

// Create a new ArrayList to hold the Customer objects.
private ArrayList customerArray = new ArrayList(); 

private void FillMyTreeView()
{
   // Add customers to the ArrayList of Customer objects.
   for(int x=0; x<1000; x++)
   {
      customerArray.Add(new Customer("Customer" + x.ToString()));
   }

   // Add orders to each Customer object in the ArrayList.
   foreach(Customer customer1 in customerArray)
   {
      for(int y=0; y<15; y++)
      {
         customer1.CustomerOrders.Add(new Order("Order" + y.ToString()));    
      }
   }

   // Display a wait cursor while the TreeNodes are being created.
   Cursor.Current = new Cursor("MyWait.cur");

   // Suppress repainting the TreeView until all the objects have been created.
   treeView1.BeginUpdate();

   // Clear the TreeView each time the method is called.
   treeView1.Nodes.Clear();

   // Add a root TreeNode for each Customer object in the ArrayList.
   foreach(Customer customer2 in customerArray)
   {
      treeView1.Nodes.Add(new TreeNode(customer2.CustomerName));

      // Add a child treenode for each Order object in the current Customer object.
      foreach(Order order1 in customer2.CustomerOrders)
      {
         treeView1.Nodes[customerArray.IndexOf(customer2)].Nodes.Add(
           new TreeNode(customer2.CustomerName + "." + order1.OrderID));
      }
   }

   // Reset the cursor to the default for all controls.
   Cursor.Current = Cursors.Default;

   // Begin repainting the TreeView.
   treeView1.EndUpdate();
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: