Export (0) Print
Expand All

TreeNodeCollection Class

Represents a collection of TreeNode objects.

System.Object
  System.Windows.Forms.TreeNodeCollection

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

public class TreeNodeCollection : IList, 
	ICollection, IEnumerable

The TreeNodeCollection type exposes the following members.

  NameDescription
Public propertyCountGets the total number of TreeNode objects in the collection.
Public propertyIsReadOnlyGets a value indicating whether the collection is read-only.
Public propertyItem[Int32]Gets or sets the TreeNode at the specified indexed location in the collection.
Public propertyItem[String]Gets the tree node with the specified key from the collection.
Top

  NameDescription
Public methodAdd(String)Adds a new tree node with the specified label text to the end of the current tree node collection.
Public methodAdd(TreeNode)Adds a previously created tree node to the end of the tree node collection.
Public methodAdd(String, String)Creates a new tree node with the specified key and text, and adds it to the collection.
Public methodAdd(String, String, Int32)Creates a tree node with the specified key, text, and image, and adds it to the collection.
Public methodAdd(String, String, String)Creates a tree node with the specified key, text, and image, and adds it to the collection.
Public methodAdd(String, String, Int32, Int32)Creates a tree node with the specified key, text, and images, and adds it to the collection.
Public methodAdd(String, String, String, String)Creates a tree node with the specified key, text, and images, and adds it to the collection.
Public methodAddRangeAdds an array of previously created tree nodes to the collection.
Public methodClearRemoves all tree nodes from the collection.
Public methodContainsDetermines whether the specified tree node is a member of the collection.
Public methodContainsKeyDetermines whether the collection contains a tree node with the specified key.
Public methodCopyToCopies the entire collection into an existing array at a specified location within the array.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindFinds the tree nodes with specified key, optionally searching subnodes.
Public methodGetEnumeratorReturns an enumerator that can be used to iterate through the tree node collection.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index of the specified tree node in the collection.
Public methodIndexOfKeyReturns the index of the first occurrence of a tree node with the specified key.
Public methodInsert(Int32, String)Creates a tree node with the specified text and inserts it at the specified index.
Public methodInsert(Int32, TreeNode)Inserts an existing tree node into the tree node collection at the specified location.
Public methodInsert(Int32, String, String)Creates a tree node with the specified text and key, and inserts it into the collection.
Public methodInsert(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.
Public methodInsert(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.
Public methodInsert(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.
Public methodInsert(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.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves the specified tree node from the tree node collection.
Public methodRemoveAtRemoves a tree node from the tree node collection at a specified index.
Public methodRemoveByKeyRemoves the tree node with the specified key from the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallel()Overloaded. Enables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsParallel()Overloaded. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryable()Overloaded. Converts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodAsQueryable()Overloaded. (Defined by Queryable.)
Public Extension MethodCast<TResult>()Overloaded. Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodCast<TResult>()Overloaded. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>()Overloaded. Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>()Overloaded. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedInfrastructure. Gets a value indicating whether access to the collection is synchronized (thread safe).
Explicit interface implemetationPrivate propertyICollection.SyncRootInfrastructure. Gets an object that can be used to synchronize access to the collection.
Explicit interface implemetationPrivate methodIList.AddInfrastructure. Adds an object to the end of the tree node collection.
Explicit interface implemetationPrivate methodIList.ContainsInfrastructure. Determines whether the specified tree node is a member of the collection.
Explicit interface implemetationPrivate methodIList.IndexOfInfrastructure. Returns the index of the specified tree node in the collection.
Explicit interface implemetationPrivate methodIList.InsertInfrastructure. Inserts an existing tree node in the tree node collection at the specified location.
Explicit interface implemetationPrivate propertyIList.IsFixedSizeInfrastructure. Gets a value indicating whether the tree node collection has a fixed size.
Explicit interface implemetationPrivate propertyIList.ItemInfrastructure. Gets or sets the tree node at the specified index in the collection.
Explicit interface implemetationPrivate methodIList.RemoveInfrastructure. Removes the specified tree node from the tree node collection.
Top

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

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

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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