Infragistics2.Win.UltraWinTree.v8.1
Handle Property
See Also  Example
Infragistics.Win.UltraWinTree Namespace > UltraTreeNode Class : Handle Property

Gets the handle of the tree node. If a handle is not already assigned when the Handle property is referenced, it is assigned at that time.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property Handle As IntPtr
C# 
public IntPtr Handle {get;}

Remarks

The handle is just an integer that uniquely identifies a node during a session, even across different tree controls.

However, be aware that this handle is only valid during the session and is therefore not persistable.

Example

The following sample code illustrates some of the information exposed by a mode.

Visual BasicCopy Code
    Imports Infragistics.Win.UltraWinTree

    Private Sub button19_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles button19.Click

        Dim node As UltraTreeNode

        ' Get the top node. This is the first node that
        ' is currently scrooled to the top of the tree.
        node = Me.ultraTree1.TopNode

        ' Loop over all visible nodes (this bypasses nodes
        ' whose 'Visible' property is false as well as
        ' nodes with a collpased parent node)
        While Not node Is Nothing

            ' Write node's key.
            Debug.WriteLine("node key: " + node.Key)

            ' Indent the rest of the output.
            Debug.Indent()

            ' Write out the node handle's value. The handle is
            ' just an integer that uniquely identifies a node
            ' during a session, even across different tree
            ' controls. However, be aware that this handle is
            ' only valid during the session and is therefore
            ' not persistable.
            Debug.WriteLine("handle: " + node.Handle.ToString())

            ' Write out some additonal information about the node
            Debug.WriteLine("text: " + node.Text)
            Debug.WriteLine("level: " + node.Level.ToString())
            Debug.WriteLine("index: " + node.Index.ToString())
            Debug.WriteLine("visible: " + node.Visible.ToString())
            Debug.WriteLine("expanded: " + node.Expanded.ToString())
            Debug.WriteLine("check state: " + node.CheckedState.ToString())
            Debug.WriteLine("full path: " + node.FullPath.ToString())

            Debug.WriteLine("style: " + node.NodeStyleResolved.ToString())

            Debug.WriteLine("tip style: " + node.TipStyleNodeResolved.ToString())

            Debug.WriteLine("ShowExpansionIndicator: " + node.ShowExpansionIndicatorResolved.ToString())

            Debug.WriteLine("AllowAutoDragExpand: " + node.AllowAutoDragExpandResolved.ToString())

            If node.AllowDeleteResolved = True Then
                Debug.WriteLine("allow the deletion of this node.")
            End If

            If node.DrawImageBackgroundResolved = DefaultableBoolean.True Then
                Debug.WriteLine("will draw a backround image if one is set.")
            End If

            If node.HasExpansionIndicator = True Then
                Debug.WriteLine("has an expansion indicator.")
            End If

            If node.HotTrackingResolved = True Then
                Debug.WriteLine("supports hot tracking.")
            End If

            If node.LabelEditResolved = True Then
                Debug.WriteLine("allow user editing of this node's text.")
            End If

            If node.EnabledResolved = True Then
                Debug.WriteLine("is enabled.")
            Else
                Debug.WriteLine("is disabled.")
            End If

            If node.IsInView = True Then
                Debug.WriteLine("is in view.")
            Else
                Debug.WriteLine("is not in view.")
            End If

            If node.IsActive = True Then
                Debug.WriteLine("is active.")
            End If

            If node.IsDraggable = True Then
                Debug.WriteLine("is draggable.")
            End If

            If node.IsEditing = True Then
                Debug.WriteLine("is in edit.")
            End If

            If node.IsHotTracking = True Then
                Debug.WriteLine("is hot tracking.")
            End If

            If node.IsRootLevelNode = True Then
                Debug.WriteLine("is root node.")
            Else
                Debug.WriteLine("root node: " + node.RootNode.Key)

                If Not node.PrevVisibleNode Is Nothing Then
                    Debug.WriteLine("previous visible node: " + node.PrevVisibleNode.Key)
                End If
            End If

            If node.IsSelectable = True Then
                Debug.WriteLine("is selectable.")
            End If

            If node.ReserveCheckBoxSpaceResolved = True Then
                Debug.WriteLine("reserve space for a checkbox even if the NodeStyle is not a checkbox or option style.")
            End If

            If node.ReserveImageSpaceResolved = True Then
                Debug.WriteLine("reserve space for an image even if there isn't one.")
            End If

            Debug.WriteLine("double click action: " _
              + node.NodeDoubleClickActionResolved.ToString())

            Debug.WriteLine("width of the text: " _
             + node.TextWidth.ToString() _
             + " pixels.")

            Debug.WriteLine("height of the node: " _
             + node.ItemHeightResolved.ToString() _
             + " pixels.")

            Debug.WriteLine("bounds: " _
             + node.Bounds.ToString())

            Debug.WriteLine("image size: " _
             + node.ImageSizeResolved.ToString())

            Debug.WriteLine("# of sibling nodes: " _
             + node.ParentNodesCollection.Count.ToString())

            ' Reset the output indent level
            Debug.IndentLevel = 0

            ' get the next visible node
            node = node.NextVisibleNode

        End While

    End Sub

C#Copy Code
       using System.Diagnostics;
       using Infragistics.Win.UltraWinTree;


       private void button19_Click(object sender, System.EventArgs e)
       {

           UltraTreeNode node;

           // Get the top node. This is the first node that
           // is currently scrooled to the top of the tree.
           node = this.ultraTree1.TopNode;

           // Loop over all visible nodes (this bypasses nodes
           // whose 'Visible' property is false as well as
           // nodes with a collpased parent node)
           while (node != null)
           {
               // Write node's key.
               Debug.WriteLine( "node key: " + node.Key );

               // Indent the rest of the output.
               Debug.Indent();

               // Write out the node handle's value. The handle is
               // just an integer that uniquely identifies a node
               // during a session, even across different tree
               // controls. However, be aware that this handle is
               // only valid during the session and is therefore
               // not persistable.
               Debug.WriteLine("handle: " + node.Handle.ToString());

               // Write out some additonal information about the node
               Debug.WriteLine( "text: " + node.Text );
               Debug.WriteLine("level: " + node.Level.ToString());
               Debug.WriteLine("index: " + node.Index.ToString());
               Debug.WriteLine("visible: " + node.Visible.ToString());
               Debug.WriteLine("expanded: " + node.Expanded.ToString());
               Debug.WriteLine("check state: " + node.CheckedState.ToString());
               Debug.WriteLine("full path: " + node.FullPath.ToString());

               Debug.WriteLine("style: "
                   + node.NodeStyleResolved.ToString() );

               Debug.WriteLine("tip style: "
                   + node.TipStyleNodeResolved.ToString() );
               
               Debug.WriteLine("ShowExpansionIndicator: "
                   + node.ShowExpansionIndicatorResolved.ToString() );
               
               Debug.WriteLine("AllowAutoDragExpand: "
                   + node.AllowAutoDragExpandResolved.ToString() );
           
               if ( node.AllowDeleteResolved )
                   Debug.WriteLine("allow the deletion of this node.");
           
               if ( node.DrawImageBackgroundResolved
                       == DefaultableBoolean.True )
                   Debug.WriteLine("will draw a backround image if one is set.");
           
               if ( node.HasExpansionIndicator )
                   Debug.WriteLine("has an expansion indicator.");
           
               if ( node.HotTrackingResolved )
                   Debug.WriteLine("supports hot tracking.");
           
               if ( node.LabelEditResolved )
                   Debug.WriteLine("allow user editing of this node's text.");
               
               if ( node.EnabledResolved )
                   Debug.WriteLine("is enabled.");
               else
                   Debug.WriteLine("is disabled.");
               
               if ( node.IsInView )
                   Debug.WriteLine("is in view.");
               else
                   Debug.WriteLine("is not in view.");
               
               if ( node.IsActive )
                   Debug.WriteLine("is active.");
               
               if ( node.IsDraggable )
                   Debug.WriteLine("is draggable.");
               
               if ( node.IsEditing )
                   Debug.WriteLine("is in edit.");
               
               if ( node.IsHotTracking )
                   Debug.WriteLine("is hot tracking.");
               
               if ( node.IsRootLevelNode )
                   Debug.WriteLine("is root node.");
               else
                   Debug.WriteLine("root node: "
                       + node.RootNode.Key );
               
               if ( node.PrevVisibleNode != null )
                   Debug.WriteLine("previous visible node: "
                       + node.PrevVisibleNode.Key );
               
               if ( node.IsSelectable )
                   Debug.WriteLine("is selectable.");
   
               if ( node.ReserveCheckBoxSpaceResolved )
                   Debug.WriteLine("reserve space for a checkbox even if the NodeStyle is not a checkbox or option style.");
   
               if ( node.ReserveImageSpaceResolved )
                   Debug.WriteLine("reserve space for an image even if there isn't one.");
               
               Debug.WriteLine("double click action: "
                   + node.NodeDoubleClickActionResolved.ToString() );
               
               Debug.WriteLine("width of the text: "
                   + node.TextWidth.ToString()
                   + " pixels." );
               
               Debug.WriteLine("height of the node: "
                   + node.ItemHeightResolved.ToString()
                   + " pixels." );
               
               Debug.WriteLine("bounds: "
                   + node.Bounds.ToString() );

               Debug.WriteLine("image size: "
                   + node.ImageSizeResolved.ToString() );

               Debug.WriteLine("# of sibling nodes: "
                   + node.ParentNodesCollection.Count.ToString() );

               // Reset the output indent level
               Debug.IndentLevel = 0;

               // get the next visible node
               node = node.NextVisibleNode;
           }

       }

See Also