Click here to Skip to main content
Click here to Skip to main content

Tagged as

How to display a control's hierarchy as a string

, 26 Feb 2013
Rate this:
Please Sign up or sign in to vote.
I created an extension method that allows my program to find all of a control's parents' names. It returns a string separated overrideable delimiter (::).  This code is targeted for .NET 4 Client, but should also work in .NET 3.5.Module WinformControlExtensions  '''   ''' Find all of the control's
I created an extension method that allows my program to find all of a control's parents' names. It returns a string separated overrideable delimiter (::).  This code is targeted for .NET 4 Client, but should also work in .NET 3.5.
Module WinformControlExtensions
  ''' <summary>
  ''' Find all of the control's parents' names and return a string of the complete hierarchy
  ''' </summary>
  ''' <param name="Control"><c><seealso cref="System.Windows.Forms.Control">Control</seealso></c> 
  ''' from which to display the hierarchy.</param>
  ''' <returns><c><seealso cref="String">String</seealso></c> of the parents' names.</returns>
  ''' <remarks></remarks>
  <System.Runtime.CompilerServices.Extension()>
  Public Function ToControlHierarchy(ByRef Control As Control, _
                                     Optional ByVal Separator As String = "::") As String
    Dim oStack As New Stack()

    Dim oParent As Control = Control.Parent
    oStack.Push(Control.Name)
    Do Until IsNothing(oParent)
      oStack.Push(oParent.Name)
      oParent = oParent.Parent
    Loop

    Dim sFullName As String = String.Empty
    Do While oStack.Count > 0
      sFullName &= oStack.Pop() & Separator
    Loop

    Return sFullName.Substring(0, sFullName.Length - Separator.Length)
  End Function
End Module

An example usage:

Dim oList As List(Of Control) = Me.FindAllChildren()

Dim oControl As Control
For Each oControl In oList
  Console.WriteLine(oControl.ToControlHierarchy("!"))
Next

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Adam Zuckerman
Software Developer (Senior)
United States United States
Long time software engineer who rambles occasionally about coding, best practices, and other random things.
Follow on   Twitter   Google+

Comments and Discussions

 
SuggestionSmall optimization PinmemberPikoslav28-Feb-13 3:28 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.140827.1 | Last Updated 27 Feb 2013
Article Copyright 2013 by Adam Zuckerman
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid