IPeekableItem Interface

Visual Studio 2015
 

Represents an object (for instance a symbol in a document) that can be a source of a IPeekSession.

Namespace:   Microsoft.VisualStudio.Language.Intellisense
Assembly:  Microsoft.VisualStudio.Language.Intellisense (in Microsoft.VisualStudio.Language.Intellisense.dll)

public interface IPeekableItem

NameDescription
System_CAPS_pubpropertyDisplayName

Gets the localized string used for displaying this item to the user.

System_CAPS_pubpropertyRelationships

Gets an enumeration of all the relationships supported by this instance.

NameDescription
System_CAPS_pubmethodGetOrCreateResultSource(String)

Gets or creates an IPeekResultSource instance representing a source of results of querying this IPeekableItem for the given relationship.

Content-type specific Peek providers define concrete IPeekableItem implementations holding onto all the context they need to provide IPeekResults for the item referenced at the IPeekSession's trigger point and relationship. When an IPeekSession> is triggered, IPeekableItemSource s matching the document's content type will be called in order (defined by the content type specificity and Order attributes) to analyze the PeekSession's trigger point and relationship. If an IPeekableItemSource recognizes the trigger point as a location of an item the provider can provide IPeekResults for the relationship, it creates its concrete IPeekableItem instance capturing all the necessary context and adds it to the IPeekSession. Then the Peek provider will be called to provide IPeekResults given this IPeekableItem instance.

Return to top
Show: