IPeekSession Interface

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.12.215

Defines a Peek session, which is a type of IntelliSense session.

public interface class IPeekSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface class IPeekSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

__interface IPeekSession : Microsoft::VisualStudio::Language::Intellisense::IIntellisenseSession, Microsoft::VisualStudio::Utilities::IPropertyOwner

public interface IPeekSession : Microsoft.VisualStudio.Language.Intellisense.IIntellisenseSession, Microsoft.VisualStudio.Utilities.IPropertyOwner

type IPeekSession = interface
    interface IIntellisenseSession
    interface IPropertyOwner

Public Interface IPeekSession
Implements IIntellisenseSession, IPropertyOwner

Derived

Microsoft.VisualStudio.Language.Intellisense.IPeekSession2

Implements

IIntellisenseSession IPropertyOwner

Remarks

IPeekSession instances are created and managed by the IPeekBroker service.

Properties

CreationOptions	Gets the PeekSessionCreationOptions that was used to create this Peek session.
IsDismissed	Determines whether the session is dismissed. (Inherited from IIntellisenseSession)
PeekableItems	Gets the collection of IPeekableItem objects.
Presenter	Gets the IIntellisensePresenter that is used to render IntelliSense for this session. (Inherited from IIntellisenseSession)
Properties	The collection of properties controlled by the property owner. (Inherited from IPropertyOwner)
RelationshipName	Case insensitive name of the relationship to which this session pertains.
TextView	Gets the ITextView inside of which this IntelliSense session was triggered. (Inherited from IIntellisenseSession)

Methods

Collapse()	Collapses the session to an unobtrusive state in which it doesn't get in the way of the user. If the session has no such state, the session will be dismissed. (Inherited from IIntellisenseSession)
Dismiss()	Dismisses the session, causing the presenter to be destroyed and the session to be removed from the session stack. (Inherited from IIntellisenseSession)
GetTriggerPoint(ITextBuffer)	Gets the ITrackingPoint at which this IntelliSense session was triggered in terms of the specified ITextBuffer. (Inherited from IIntellisenseSession)
GetTriggerPoint(ITextSnapshot)	Gets the SnapshotPoint at which this IntelliSense session was triggered in terms of the specified ITextSnapshot. (Inherited from IIntellisenseSession)
Match()	Determines the best matching item in the session and sets the selection to this item. (Inherited from IIntellisenseSession)
QueryPeekResults(IPeekableItem, String)	Starts asynchronous query for IPeekResults for the given relationship on the given IPeekableItem.
Recalculate()	Recalculates the underlying IntelliSense items pertaining to this session, using the same trigger point. (Inherited from IIntellisenseSession)
Start()	Starts the session. (Inherited from IIntellisenseSession)
TriggerNestedPeekSession(IPeekSession)	Starts the nested Peek session, queries IPeekableItemSources for IPeekableItems and raises NestedPeekTriggered event on success.

Events

Dismissed	Occurs when the session is dismissed. (Inherited from IIntellisenseSession)
NestedPeekTriggered	Occurs when nested Peek command is triggered. In a typical case this event occurs when Peek command is invoked on a text view that represents one of Peek results pertaining to this Peek session.
PresenterChanged	Occurs when the IntelliSense presenter for this session changes. (Inherited from IIntellisenseSession)
Recalculated	Occurs when the session is recalculated. (Inherited from IIntellisenseSession)