IVsUIHierarchyWindow Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class IVsUIHierarchyWindow

public interface class IVsUIHierarchyWindow

__interface IVsUIHierarchyWindow

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("A2DD88C9-D878-4323-95A3-77DAF258E5D0")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsUIHierarchyWindow

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("A2DD88C9-D878-4323-95A3-77DAF258E5D0")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsUIHierarchyWindow

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("A2DD88C9-D878-4323-95A3-77DAF258E5D0")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsUIHierarchyWindow = interface

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("A2DD88C9-D878-4323-95A3-77DAF258E5D0")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsUIHierarchyWindow = interface

Public Interface IVsUIHierarchyWindow

Derived: Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchyWindow2

Attributes: ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

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).

Methods

AddUIHierarchy(IVsUIHierarchy, UInt32)	Adds an additional root UI hierarchy node to the list managed by the UI hierarchy window.
ExpandItem(IVsUIHierarchy, UInt32, EXPANDFLAGS)	Controls the state or appearance of items in the hierarchy.
FindCommonSelectedHierarchy(UInt32, IVsUIHierarchy)	Finds the lowermost hierarchy that is the nearest ancestor to every selected node.
GetCurrentSelection(IntPtr, UInt32, IVsMultiItemSelect)	Gets the alternate itemID of the current selection when an alternate UIHierarchy is used.
GetItemState(IVsUIHierarchy, UInt32, UInt32, UInt32)	Returns the state or appearance of the hierarchy.
Init(IVsUIHierarchy, UInt32, Object)	Initializes a custom use of a UI hierarchy window.
RemoveUIHierarchy(IVsUIHierarchy)	Removes a root UI hierarchy node from the UI hierarchy window.
SetCursor(IntPtr, IntPtr)	This method is obsolete. Calling it has no effect.
SetWindowHelpTopic(String, UInt32)	Sets the Help topic for the hierarchy window.

Applies to