UIHierarchyItems Interface

Represents a given level of the UI hierarchy tree. It also represents a collection of the selected items in the tree.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
<GuidAttribute("DB8406B0-A916-449C-A277-BB04028F4394")> _
Public Interface UIHierarchyItems _
    Inherits IEnumerable

[GuidAttribute("DB8406B0-A916-449C-A277-BB04028F4394")]
public interface UIHierarchyItems : IEnumerable

[GuidAttribute(L"DB8406B0-A916-449C-A277-BB04028F4394")]
public interface class UIHierarchyItems : IEnumerable

[<GuidAttribute("DB8406B0-A916-449C-A277-BB04028F4394")>]
type UIHierarchyItems =  
    interface 
        interface IEnumerable 
    end

public interface UIHierarchyItems extends IEnumerable

The UIHierarchyItems type exposes the following members.

Properties

	Name	Description
	Count	Gets a value indicating the number of objects in the UIHierarchyItems collection.
	DTE	Gets the top-level extensibility object.
	Expanded	Sets or gets whether a node in the hierarchy is expanded.
	Parent	Gets the immediate parent object of a UIHierarchyItems collection.

Top

Methods

	Name	Description
	GetEnumerator	Gets an enumeration for items in a collection.
	Item	Returns a UIHierarchyItem object in a UIHierarchyItems collection.

Top

Remarks

For alternate ways to use the UIHierarchyItems collection to access nodes, see UIHierarchy object.

Examples

Sub UIHierarchyItemsExample()
   ' Reference the UIHierarchy, UIHierarchyItem, and OutputWindow objects.
   Dim UIH As UIHierarchy = _
     DTE.Windows.Item(Constants.vsWindowKindMacroExplorer).Object
   Dim samples As UIHierarchyItem = UIH.GetItem("Macros\Samples")
   Dim OWPane As OutputWindowPane = GetOutputWindowPane("List Macros")
   Dim file As UIHierarchyItem

   OWPane.Clear()
   For Each file In samples.UIHierarchyItems
      OWPane.OutputString(file.Name &  _
        Microsoft.VisualBasic.Constants.vbCrLf)
      Dim macro As UIHierarchyItem
      For Each macro In file.UIHierarchyItems
         OWPane.OutputString("   " & macro.Name & _
           Microsoft.VisualBasic.Constants.vbCrLf)
      Next
   Next
End Sub

Function GetOutputWindowPane(ByVal Name As String, Optional ByVal show _
  As Boolean = True) As OutputWindowPane
   Dim win As Window = _
     DTE.Windows.Item(EnvDTE.Constants.vsWindowKindOutput)
   If show Then win.Visible = True
   Dim ow As OutputWindow = win.Object
   Dim owpane As OutputWindowPane
   Try
      owpane = ow.OutputWindowPanes.Item(Name)
   Catch e As System.Exception
      owpane = ow.OutputWindowPanes.Add(Name)
   End Try
   owpane.Activate()
   Return owpane
End Function

See Also

Reference

EnvDTE Namespace

Other Resources

How to: Manipulate Tree Views by Using UIHierarchy