IVsObjectBrowserDescription3 Interface

 

Provides a means for entering Object Browser description text.

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

[GuidAttribute("2BCD7A6A-D251-4286-9A61-BDEDDE91114F")]
[InterfaceTypeAttribute(1)]
public interface IVsObjectBrowserDescription3

NameDescription
System_CAPS_pubmethodAddDescriptionText3(String, VSOBDESCRIPTIONSECTION, IVsNavInfo)

Adds elements of description text to the Object Browser.

System_CAPS_pubmethodClearDescriptionText()

Clears the Object Browser description text.

When an object is selected in the Object Browser, a description of the object appears in the lower pane (Description Pane) of the window. The description text is built through a series of calls to AddDescriptionText3. The environment will call FillDescription for the item of interest. The call passes in an IVsObjectBrowserDescription3 interface. This is similar to an IStream interface in that you repeatedly call IVsObjectBrowserDescription3 to write your description as a series of elements. The elements are identified with the VSOBDESCRIPTIONSECTION enumeration.

Return to top
Show: