TreeNode Класс

Определение

Предоставляет узел объекта TreeView.Represents a node of a TreeView.

public ref class TreeNode : MarshalByRefObject, ICloneable, System::Runtime::Serialization::ISerializable
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.TreeNodeConverter))]
[System.Serializable]
public class TreeNode : MarshalByRefObject, ICloneable, System.Runtime.Serialization.ISerializable
type TreeNode = class
    inherit MarshalByRefObject
    interface ICloneable
    interface ISerializable
Public Class TreeNode
Inherits MarshalByRefObject
Implements ICloneable, ISerializable
Наследование
Производный
Атрибуты
Реализации

Примеры

В следующем примере кода отображаются сведения о клиенте в элементе управления TreeView.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. В этом примере 1 000 клиентов отображаются с 15 заказами.In this example, 1,000 customers are displayed with 15 orders each. Перерисовка TreeView подавляется с помощью методов BeginUpdate и EndUpdate, а Cursor ожидания отображается, когда TreeView создает и закрашивает объекты TreeNode.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. В этом примере требуется объект Customer, который может содержать коллекцию объектов Order.This example requires that you have a Customer object that can hold a collection of Order objects. Также требуется, чтобы на Formбыл создан экземпляр элемента управления TreeView.It also requires that you have created an instance of a TreeView control on a Form.

// The basic Customer class.
ref class Customer: public System::Object
{
private:
   String^ custName;

protected:
   ArrayList^ custOrders;

public:
   Customer( String^ customername )
   {
      custName = "";
      custOrders = gcnew ArrayList;
      this->custName = customername;
   }


   property String^ CustomerName 
   {
      String^ get()
      {
         return this->custName;
      }

      void set( String^ value )
      {
         this->custName = value;
      }

   }

   property ArrayList^ CustomerOrders 
   {
      ArrayList^ get()
      {
         return this->custOrders;
      }

   }

};


// End Customer class
// The basic customer Order class.
ref class Order: public System::Object
{
private:
   String^ ordID;

public:
   Order( String^ orderid )
   {
      ordID = "";
      this->ordID = orderid;
   }


   property String^ OrderID 
   {
      String^ get()
      {
         return this->ordID;
      }

      void set( String^ value )
      {
         this->ordID = value;
      }

   }

};
// End Order class



void FillMyTreeView()
{
   // Add customers to the ArrayList of Customer objects.
   for ( int x = 0; x < 1000; x++ )
   {
      customerArray->Add( gcnew Customer( "Customer " + x ) );
   }
   
   // Add orders to each Customer object in the ArrayList.
   IEnumerator^ myEnum = customerArray->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Customer^ customer1 = safe_cast<Customer^>(myEnum->Current);
      for ( int y = 0; y < 15; y++ )
      {
         customer1->CustomerOrders->Add( gcnew Order( "Order " + y ) );
      }
   }

   // Display a wait cursor while the TreeNodes are being created.
   ::Cursor::Current = gcnew System::Windows::Forms::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.
   myEnum = customerArray->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Customer^ customer2 = safe_cast<Customer^>(myEnum->Current);
      treeView1->Nodes->Add( gcnew TreeNode( customer2->CustomerName ) );
      
      // Add a child treenode for each Order object in the current Customer object.
      IEnumerator^ myEnum = customer2->CustomerOrders->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         Order^ order1 = safe_cast<Order^>(myEnum->Current);
         treeView1->Nodes[ customerArray->IndexOf( customer2 ) ]->Nodes->Add( gcnew TreeNode( customer2->CustomerName + "." + order1->OrderID ) );
      }
   }
   
   // Reset the cursor to the default for all controls.
   ::Cursor::Current = Cursors::Default;
   
   // Begin repainting the TreeView.
   treeView1->EndUpdate();
}

// 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();
}
Public Class Customer
   Inherits [Object]
   Private custName As String = ""
   Friend custOrders As New ArrayList()

   Public Sub New(ByVal customername As String)
      Me.custName = customername
   End Sub

   Public Property CustomerName() As String
      Get
         Return Me.custName
      End Get
      Set(ByVal Value As String)
         Me.custName = Value
      End Set
   End Property

   Public ReadOnly Property CustomerOrders() As ArrayList
      Get
         Return Me.custOrders
      End Get
   End Property
End Class


Public Class Order
   Inherits [Object]
   Private ordID As String

   Public Sub New(ByVal orderid As String)
      Me.ordID = orderid
   End Sub

   Public Property OrderID() As String
      Get
         Return Me.ordID
      End Get
      Set(ByVal Value As String)
         Me.ordID = Value
      End Set
   End Property
End Class

' Create a new ArrayList to hold the Customer objects.
Private customerArray As New ArrayList()

Private Sub FillMyTreeView()
   ' Add customers to the ArrayList of Customer objects.
   Dim x As Integer
   For x = 0 To 999
      customerArray.Add(New Customer("Customer" + x.ToString()))
   Next x

   ' Add orders to each Customer object in the ArrayList.
   Dim customer1 As Customer
   For Each customer1 In customerArray
      Dim y As Integer
      For y = 0 To 14
         customer1.CustomerOrders.Add(New Order("Order" + y.ToString()))
      Next y
   Next customer1

   ' 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.
   Dim customer2 As Customer
   For Each customer2 In customerArray
      treeView1.Nodes.Add(New TreeNode(customer2.CustomerName))

      ' Add a child TreeNode for each Order object in the current Customer object.
      Dim order1 As Order
      For Each order1 In customer2.CustomerOrders
         treeView1.Nodes(customerArray.IndexOf(customer2)).Nodes.Add( _
    New TreeNode(customer2.CustomerName + "." + order1.OrderID))
      Next order1
   Next customer2

   ' Reset the cursor to the default for all controls.
   Cursor.Current = System.Windows.Forms.Cursors.Default

   ' Begin repainting the TreeView.
   treeView1.EndUpdate()
End Sub

Комментарии

Коллекция Nodes содержит все дочерние объекты TreeNode, назначенные текущему TreeNode.The Nodes collection holds all the child TreeNode objects assigned to the current TreeNode. Можно добавлять, удалять или клонировать TreeNode; После этого все дочерние узлы дерева добавляются, удаляются или клонируется.You can add, remove, or clone a TreeNode; when you do this, all child tree nodes are added, removed, or cloned. Каждый TreeNode может содержать коллекцию других объектов TreeNode.Each TreeNode can contain a collection of other TreeNode objects. Это может усложнить определение места в TreeView при переборе коллекции.This can make it difficult to determine where you are in the TreeView when iterating through the collection. Чтобы определить расположение в древовидной структуре, используйте свойство FullPath.To determine your location in a tree structure, use the FullPath property. Строку FullPath можно проанализировать с помощью PathSeparator строкового значения, чтобы определить начало и конец метки TreeNode.The FullPath string can be parsed using the PathSeparator string value to determine where a TreeNode label begins and ends.

Метка TreeNode задается явным образом путем установки свойства Text.The TreeNode label is set by setting the Text property explicitly. Альтернативой является создание узла дерева с помощью одного из конструкторов TreeNode, имеющих строковый параметр, представляющий свойство Text.The alternative is to create the tree node using one of the TreeNode constructors that has a string parameter that represents the Text property. Метка отображается рядом с изображением TreeNode, если оно отображается.The label is displayed next to the TreeNode image, if one is displayed.

Чтобы отобразить изображения рядом с узлами дерева, назначьте ImageList свойству ImageList родительского элемента управления TreeView и назначьте Image, ссылаясь на значение индекса в свойстве ImageList.To display images next to the tree nodes, assign an ImageList to the ImageList property of the parent TreeView control and assign an Image by referencing its index value in the ImageList property. Присвойте свойству ImageIndex значение индекса Image, который требуется отобразить, если TreeNode находится в невыбранном состоянии.Set the ImageIndex property to the index value of the Image you want to display when the TreeNode is in an unselected state. Аналогичным образом задайте для свойства SelectedImageIndex значение индекса Image, который требуется отобразить при выборе TreeNode.Likewise, set the SelectedImageIndex property to the index value of the Image you want to display when the TreeNode is selected.

Выбор конкретных узлов дерева и итерация коллекции Nodes можно достичь с помощью следующих значений свойств: FirstNode, LastNode, NextNode, PrevNode, NextVisibleNode, PrevVisibleNode.Selecting specific tree nodes and iterating through the Nodes collection can be achieved by using the following property values: FirstNode, LastNode, NextNode, PrevNode, NextVisibleNode, PrevVisibleNode. Назначьте TreeNode, возвращаемый одним из вышеупомянутых свойств, свойству TreeView.SelectedNode, чтобы выбрать этот узел дерева в элементе управления TreeView.Assign the TreeNode returned by one of aforementioned properties to the TreeView.SelectedNode property to select that tree node in the TreeView control.

Узлы дерева можно разворачивать для просмотра следующего уровня дочерних узлов дерева.Tree nodes can be expanded to display the next level of child tree nodes. Пользователь может развернуть TreeNode, нажав кнопку со знаком "плюс" (+) рядом с TreeNode, если она отображается, или можно развернуть TreeNode, вызвав метод Expand.The user can expand the TreeNode by pressing the plus (+) button next to the TreeNode, if one is displayed, or you can expand the TreeNode by calling the Expand method. Чтобы развернуть все уровни дочерних узлов дерева в коллекции Nodes, вызовите метод ExpandAll.To expand all child tree node levels in the Nodes collection, call the ExpandAll method. Можно свернуть дочерний уровень TreeNode, вызвав метод Collapse, или пользователь может нажать кнопку со знаком "минус" (-) рядом с TreeNode, если она отображается.You can collapse the child TreeNode level by calling the Collapse method, or the user can press the minus (-) button next to the TreeNode, if one is displayed. Можно также вызвать метод Toggle, чтобы альтернативировать TreeNode между развернутым и свернутым состояниями.You can also call the Toggle method to alternate the TreeNode between the expanded and collapsed states.

Узлы дерева могут дополнительно отображать флажок.Tree nodes can optionally display a check box. Чтобы отобразить флажки, установите для свойства CheckBoxes TreeView значение true.To display the check boxes, set the CheckBoxes property of the TreeView to true. Свойству Checked присвоено значение true для узлов дерева, которые находятся в установленном состоянии.The Checked property is set to true for tree nodes that are in a checked state.

Конструкторы

TreeNode()

Инициализация нового экземпляра класса TreeNode.Initializes a new instance of the TreeNode class.

TreeNode(SerializationInfo, StreamingContext)

Инициализирует новый экземпляр класса TreeNode, используя указанные сведения о сериализации и контекст.Initializes a new instance of the TreeNode class using the specified serialization information and context.

TreeNode(String)

Инициализирует новый экземпляр класса TreeNode с заданной текстовой меткой.Initializes a new instance of the TreeNode class with the specified label text.

TreeNode(String, Int32, Int32)

Инициализирует новый экземпляр класса TreeNode с заданной текстовой меткой и рисунками, когда узел дерева находится в выбранном и невыбранном состоянии.Initializes a new instance of the TreeNode class with the specified label text and images to display when the tree node is in a selected and unselected state.

TreeNode(String, Int32, Int32, TreeNode[])

Инициализирует новый экземпляр класса TreeNode с заданной текстовой меткой, дочерними узлами дерева и рисунками, когда узел дерева находится в выбранном и невыбранном состоянии.Initializes a new instance of the TreeNode class with the specified label text, child tree nodes, and images to display when the tree node is in a selected and unselected state.

TreeNode(String, TreeNode[])

Инициализирует новый экземпляр класса TreeNode с заданной текстовой меткой и дочерними узлами дерева.Initializes a new instance of the TreeNode class with the specified label text and child tree nodes.

Свойства

BackColor

Возвращает или задает цвет фона для узла дерева.Gets or sets the background color of the tree node.

Bounds

Возвращает границы узла дерева.Gets the bounds of the tree node.

Checked

Возвращает или задает значение, определяющее, находится ли узел дерева в выбранном состоянии.Gets or sets a value indicating whether the tree node is in a checked state.

ContextMenu

Получает или задает контекстное меню, связанное с этим узлом дерева.Gets the shortcut menu that is associated with this tree node.

ContextMenuStrip

Возвращает или задает контекстное меню, связанное с этим узлом дерева.Gets or sets the shortcut menu associated with this tree node.

FirstNode

Получает первый дочерний узел дерева из коллекции узлов дерева.Gets the first child tree node in the tree node collection.

ForeColor

Возвращает или задает основной цвет для узла дерева.Gets or sets the foreground color of the tree node.

FullPath

Получает путь из корневого узла дерева к текущему узлу дерева.Gets the path from the root tree node to the current tree node.

Handle

Получает дескриптор узла дерева.Gets the handle of the tree node.

ImageIndex

Возвращает или задает значение индекса списка рисунков для отображаемого изображения, когда узел дерева находится в невыбранном состоянии.Gets or sets the image list index value of the image displayed when the tree node is in the unselected state.

ImageKey

Возвращает или задает ключ для изображения, связанного с этим узлом дерева, при нахождении этого узла в невыбранном состоянии.Gets or sets the key for the image associated with this tree node when the node is in an unselected state.

Index

Возвращает местоположение узла дерева в коллекции узлов дерева.Gets the position of the tree node in the tree node collection.

IsEditing

Получает значение, определяющее, находится ли узел в доступном для изменений состоянии.Gets a value indicating whether the tree node is in an editable state.

IsExpanded

Возвращает значение, указывающее, находится ли узел дерева в развернутом состоянии.Gets a value indicating whether the tree node is in the expanded state.

IsSelected

Возвращает значение, указывающее, находится ли узел дерева в выбранном состоянии.Gets a value indicating whether the tree node is in the selected state.

IsVisible

Возвращает значение, указывающее, является ли узел дерева видимым или частично видимым.Gets a value indicating whether the tree node is visible or partially visible.

LastNode

Возвращает последний дочерний узел дерева.Gets the last child tree node.

Level

Возвращает глубину (начинающуюся с нуля) узла дерева в элементе управления TreeView.Gets the zero-based depth of the tree node in the TreeView control.

Name

Возвращает или задает имя узла дерева.Gets or sets the name of the tree node.

NextNode

Возвращает следующий узел дерева на данном уровне.Gets the next sibling tree node.

NextVisibleNode

Возвращает следующий отображаемый узел дерева.Gets the next visible tree node.

NodeFont

Получает или задает шрифт, используемый для отображения текста метки узла дерева.Gets or sets the font that is used to display the text on the tree node label.

Nodes

Возвращает коллекцию объектов TreeNode, которая назначена текущему узлу дерева.Gets the collection of TreeNode objects assigned to the current tree node.

Parent

Получает родительский узел дерева для текущего узла дерева.Gets the parent tree node of the current tree node.

PrevNode

Возвращает предшествующий узел на данном уровне.Gets the previous sibling tree node.

PrevVisibleNode

Возвращает предшествующий отображаемый узел дерева.Gets the previous visible tree node.

SelectedImageIndex

Возвращает или задает значение индекса списка рисунков, отображаемых в тех случаях, когда узел дерева находится в выбранном состоянии.Gets or sets the image list index value of the image that is displayed when the tree node is in the selected state.

SelectedImageKey

Возвращает или задает ключ изображения, отображаемого в узле дерева, находящегося в выбранном состоянии.Gets or sets the key of the image displayed in the tree node when it is in a selected state.

StateImageIndex

Получает или задает индекс изображения, используемый для указания состояния узла TreeNode, если для свойства TreeView родительского объекта CheckBoxes задано значение false.Gets or sets the index of the image that is used to indicate the state of the TreeNode when the parent TreeView has its CheckBoxes property set to false.

StateImageKey

Получает или задает ключ изображения, используемый для указания состояния узла TreeNode, если для свойства TreeView родительского объекта CheckBoxes задано значение false.Gets or sets the key of the image that is used to indicate the state of the TreeNode when the parent TreeView has its CheckBoxes property set to false.

Tag

Возвращает или задает объект, содержащий сведения об узле дерева.Gets or sets the object that contains data about the tree node.

Text

Возвращает или задает текст, отображаемый в метке узла дерева.Gets or sets the text displayed in the label of the tree node.

ToolTipText

Возвращает или задает текст, который отображается при наведении указателя мыши на объект TreeNode.Gets or sets the text that appears when the mouse pointer hovers over a TreeNode.

TreeView

Возвращает родительское представление в виде дерева, которому назначен данный узел дерева.Gets the parent tree view that the tree node is assigned to.

Методы

BeginEdit()

Инициирует редактирование метки узла дерева.Initiates the editing of the tree node label.

Clone()

Копирует узел дерева и все поддерево с этим корнем в данный узел дерева.Copies the tree node and the entire subtree rooted at this tree node.

Collapse()

Сворачивает узел дерева.Collapses the tree node.

Collapse(Boolean)

Сворачивает узел TreeNode и дополнительно сворачивает дочерние узлы.Collapses the TreeNode and optionally collapses its children.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Deserialize(SerializationInfo, StreamingContext)

Загружает состояние TreeNode из указанного SerializationInfo.Loads the state of the TreeNode from the specified SerializationInfo.

EndEdit(Boolean)

Завершает редактирование метки узла дерева.Ends the editing of the tree node label.

EnsureVisible()

Гарантирует отображение узла дерева, развертывание узлов дерева и прокрутку элемента управления отображением дерева, если это необходимо.Ensures that the tree node is visible, expanding tree nodes and scrolling the tree view control as necessary.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Expand()

Разворачивает узел дерева.Expands the tree node.

ExpandAll()

Разворачивает все дочерние узлы дерева.Expands all the child tree nodes.

FromHandle(TreeView, IntPtr)

Возвращает узел дерева с указанным дескриптором и назначает его заданному элементу управления отображением дерева.Returns the tree node with the specified handle and assigned to the specified tree view control.

GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetNodeCount(Boolean)

Возвращает количество дочерних узлов дерева.Returns the number of child tree nodes.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
Remove()

Удаляет текущий узел дерева из элемента управления отображением дерева.Removes the current tree node from the tree view control.

Serialize(SerializationInfo, StreamingContext)

Сохраняет состояние объекта TreeNode в указанный объект SerializationInfo.Saves the state of the TreeNode to the specified SerializationInfo.

Toggle()

Переключает узел дерева в развернутое или свернутое состояние.Toggles the tree node to either the expanded or collapsed state.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

Явные реализации интерфейса

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Заполняет объект сведений о сериализации данными, необходимыми для сериализации TreeNode.Populates a serialization information object with the data needed to serialize the TreeNode.

Применяется к

Дополнительно