IPeekableItem Interface
Definition
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.
Represents an object (for instance a symbol in a document) that can be a source of a IPeekSession.
public interface class IPeekableItempublic interface class IPeekableItem__interface IPeekableItempublic interface IPeekableItemtype IPeekableItem = interfacePublic Interface IPeekableItemRemarks
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, IPeekableItemSources matching the document's content type will be called in order (defined by the content type specificity and Order attributes) to analyze the IPeekSession'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.
Properties
| DisplayName |
Defines the localized string used for displaying this item to the user. |
| Relationships |
Gets an enumeration of all relationships supported by this IPeekableItem instance. |
Methods
| GetOrCreateResultSource(String) |
Gets or creates an IPeekResultSource instance representing a source of results of querying this IPeekableItem for the given relationship. |