IVsUIHierarchyWindow Interface

Implemented by the environment to display the hierarchies that VSPackages write.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

public interface IVsUIHierarchyWindow

The IVsUIHierarchyWindow type exposes the following members.

Public methodAddUIHierarchyAdds an additional root UI hierarchy node to the list managed by the UI hierarchy window.
Public methodExpandItemControls the state or appearance of items in the hierarchy.
Public methodFindCommonSelectedHierarchyFinds the lowermost hierarchy that is the nearest ancestor to every selected node.
Public methodGetCurrentSelectionGets the alternate itemID of the current selection when an alternate UIHierarchy is used.
Public methodGetItemStateReturns the state or appearance of the hierarchy.
Public methodInitInitializes a custom use of a UI hierarchy window.
Public methodRemoveUIHierarchyRemoves a root UI hierarchy node from the UI hierarchy window.
Public methodSetCursorSets a new cursor for the UI hierarchy window. This method allows you to show a different cursor in the UI hierarchy window when required to indicate specific actions.
Public methodSetWindowHelpTopicSets the Help topic for the hierarchy window.

This interface is implemented by the environment to display the hierarchies that are written by VSPackages for the existing hierarchy windows (Solutions Explorer, Macro Explorer, and Server Explorer). Using this interface, VSPackages call into the UI Hierarchy window to add, remove, expand, or select hierarchies in the window.

This interface can also be implemented on a custom UIHierarchy window. To instantiate your own UIHierarchy window, call QueryService on the SVsUIShell Service to get a pointer to the IVsUIShell interface. Once you have the pointer to this interface, call CreateToolWindow (CLASSID_VSUIHierarchyWindow). You can use the returned ppWindowFrame to get the ppunkDocView, on which QueryInterface can be called for a pointer to the IVsUIHierarchyWindow interface.

Tool tips in a UIHierarchy window are reserved to show the full caption of the node if the caption is being clipped by the current view (i.e. the window is too narrow to show the full caption). You can not provide custom tool tips for UIHierarchy windows.

See illustrations of the implementation and/or calling of this interface in the sample Basic Project.

Notes to Implementers

Implemented by the environment on the existing hierarchy windows (Solution Explorer, Macro Explorer, and Server Explorer).

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2014 Microsoft