Visual Basic: Windows Controls

  • Article

Add Method (Nodes Collection)

See Also    Example    Applies To

Adds a Node object to a Treeview control's Nodes collection.

Syntax

object.Add(relative, relationship, key, text, image, selectedimage)

The Add method syntax has these parts:

Part Description
Object Required. An object expression that evaluates to an object in the Applies To list.
Relative Optional. The index number or key of a pre-existing Node object. The relationship between the new node and this pre-existing node is found in the next argument, relationship.
Relationship Optional. Specifies the relative placement of the Node object, as described in Settings.
Key Optional. A unique string that can be used to retrieve the Node with the Item method.
Text Optiona. The string that appears in the Node.
Image Optional. The index of an image in an associated ImageList control.
Selectedimage Optional. The index of an image in an associated ImageList control that is shown when the Node is selected.

Settings

The settings for relationship are:

Constant Value Description
TvwFirst 0 First. The Node is placed before all other nodes at the same level of the node named in relative.
TvwLast 1 Last. The Node is placed after all other nodes at the same level of the node named in relative. Any Node added subsequently may be placed after one added as Last.
TvwNext 2 (Default) Next. The Node is placed after the node named in relative.
TvwPrevious 3 Previous. The Node is placed before the node named in relative.
TvwChild 4 Child. The Node becomes a child node of the node named in relative.

Note   If no Node object is named in relative, the new node is placed in the last position of the top node hierarchy.

Remarks

The Nodes collection is a 1-based collection.

As a Node object is added it is assigned an index number, which is stored in the Node object's Index property. This value of the newest member is the value of the Node collection's Count property.

Because the Add method returns a reference to the newly created Node object, it is most convenient to set properties of the new Node using this reference. The following example adds several Node objects with identical properties:

Private Sub CreateNodes()
  ' Set CheckBoxes property to True to see checked nodes:
  TreeView1.CheckBoxes = True
  Dim nodX As Node   ' Declare the object variable.
  Dim i as Integer   ' Declare a counter variable.
  For i = 1 to 4
    Set nodX = TreeView1.Nodes.Add(,,,"Node " & Cstr(i))
    ' Use the reference to set other properties, such as Bold.
    NodX.Bold = True
    ' Set image property to image 3 in an associated ImageList.
    nodX.Checked = True
  Next i
End Sub