TypeAndMemberDropdownBars Class

 

Provides support for the combo boxes showing type and member information as offered by a language service.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

System.Object
  Microsoft.VisualStudio.Package.TypeAndMemberDropdownBars

[CLSCompliantAttribute(false)]
public abstract class TypeAndMemberDropdownBars : IVsDropdownBarClient

NameDescription
System_CAPS_protmethodTypeAndMemberDropdownBars(LanguageService)

Initializes a new instance of the TypeAndMemberDropdownBars class.

NameDescription
System_CAPS_pubmethodDone()

Cleans up any allocated resources just before the TypeAndMemberDropdownBars object is destroyed.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetComboAttributes(Int32, UInt32, UInt32, IntPtr)

Returns information about the specified combo box.

System_CAPS_pubmethodGetComboTipText(Int32, String)

Returns text to be shown in a tool tip when the cursor is held over the combo box.

System_CAPS_pubmethodGetEntryAttributes(Int32, Int32, UInt32)

Returns the font attributes for the specified entry on the specified combo box.

System_CAPS_pubmethodGetEntryImage(Int32, Int32, Int32)

Returns the glyph index for the specified entry on the specified combo box.

System_CAPS_pubmethodGetEntryText(Int32, Int32, String)

Returns the text to be displayed for the specified entry in the specified combo box.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetMember(Int32, Int32)

Returns the specified entry for the specified combo box.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodOnComboGetFocus(Int32)

Called when a combo box gets the focus.

System_CAPS_pubmethodOnItemChosen(Int32, Int32)

Called when an item is chosen from the specified combo box.

System_CAPS_pubmethodOnItemSelected(Int32, Int32)

Called when an entry is highlighted in one of the combo boxes.

System_CAPS_pubmethodOnSynchronizeDropdowns(LanguageService, IVsTextView, Int32, Int32, ArrayList, ArrayList, Int32, Int32)

Called to fill and synchronize all combo boxes.

System_CAPS_pubmethodSetDropdownBar(IVsDropdownBar)

Called to specify the IVsDropdownBar object that controls the two combo boxes.

System_CAPS_pubmethodToString()

(Inherited from Object.)

This class is used to manage the combo boxes showing type and member information for a particular source file. These combo boxes appear in a drop-down bar (represented by an IVsDropdownBar interface) at the top of the editor view showing the source file. This class contains all the information required for Visual Studio to show and manage those combo boxes. In addition, this class contains event handlers that are called when the combo boxes are accessed by the user.

SynchronizeDropdowns is a method that is marked as internal and is called from the base CodeWindowManager class. This internal method is given an IVsTextView object when the base AddAdornments method on the CodeWindowManager class is called. The IVsTextView object is used to update the display when an item is chosen in a combo box. The SynchronizeDropdowns method is also called from the base method SynchronizeDropdowns in the LanguageService class.

Notes to Implementers:

If you plan to support the type and member combo boxes, you must derive a class from the TypeAndMemberDropdownBars class and return an instance of your class from the CreateDropDownHelper method in your version of the LanguageService class. In addition, you must implement the OnSynchronizeDropdowns method which handles the task of filling the internal lists to be shown in the combo boxes.

Notes to Callers:

An instance of your version of a TypeAndMemberDropdownBars object is returned from a call to CreateDropDownHelper in the LanguageService class. If CreateDropDownHelper returns a valid object, Visual Studio creates and manages the combo boxes for you, using information from your version of the TypeAndMemberDropdownBars class.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: