IPeekBroker Interface

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.12.215

Represents a Peek broker, which is globally responsible for managing IPeekSessions.

public interface class IPeekBroker

public interface class IPeekBroker

__interface IPeekBroker

public interface IPeekBroker

type IPeekBroker = interface

Public Interface IPeekBroker

Derived

Microsoft.VisualStudio.Language.Intellisense.IPeekBroker2

Remarks

This is a MEF component, and should be imported as follows: [Import] IPeekBroker peekBroker = null;

Methods

CanTriggerPeekSession(ITextView, ITrackingPoint, String, Predicate<String>)	Determines whether a Peek session can be triggered at a particular position, without actually triggering it. Note, that an ability to trigger a Peek session doesn't mean that when triggered the session will necessarily provide results.
CanTriggerPeekSession(ITextView, String, Predicate<String>)	Determines whether a Peek session can be triggered at the caret position, without actually triggering it. Note, that an ability to trigger a Peek session doesn't mean that when triggered the session will necessarily provide results.
CanTriggerPeekSession(PeekSessionCreationOptions, Predicate<String>)	Determines whether a Peek session can be triggered with the specified options, without actually triggering it. Note, that an ability to trigger a Peek session doesn't mean that when triggered the session will necessarily provide results.
CreatePeekSession(ITextView, ITrackingPoint, String)	Creates, but does not start a Peek session at a particular position, which is assumed to be the position of a peekable symbol on which a Peek session is requested.
CreatePeekSession(PeekSessionCreationOptions)	Creates, but does not start a Peek session with the specified options.
DismissPeekSession(ITextView)	Dismisses an active Peek session for a particular ITextView.
GetPeekSession(ITextView)	Gets the active Peek session.
IsPeekSessionActive(ITextView)	Determines whether or not a Peek session is active over the specified ITextView.
TriggerNestedPeekSession(ITextView, ITrackingPoint, String, IPeekSession)	Starts a nested Peek session at a particular position, which is assumed to be the position of a peekable symbol on which a nested Peek session is requested. A Peek session is considered to be nested when it's started from a text view that represents an IPeekResult of a containing Peek session. This method doesn't create a new Peek session though, instead it adds another IPeekableItem to the containing session.
TriggerNestedPeekSession(ITextView, String, IPeekSession)	Starts a nested Peek session, assuming the caret position to be the position of a peekable symbol on which a nested Peek session is requested. A Peek session is considered to be nested when it's started from a text view that represents an IPeekResult of a containing Peek session. This method doesn't create a new Peek session though, instead it adds another IPeekableItem to the containing session.
TriggerNestedPeekSession(PeekSessionCreationOptions, IPeekSession)	Starts a nested Peek session, assuming the options specify a peekable symbol on which a nested Peek session is requested. A Peek session is considered to be nested when it's started from a text view that represents an IPeekResult of a containing Peek session. This method doesn't create a new Peek session though, instead it adds another IPeekableItem to the containing session.
TriggerPeekSession(ITextView, ITrackingPoint, String)	Starts a Peek session at a particular position, which is assumed to be the position of a peekable symbol on which a Peek session is requested.
TriggerPeekSession(ITextView, String)	Starts a Peek session, assuming the caret position to be the position of a peekable symbol on which a Peek session is requested.
TriggerPeekSession(PeekSessionCreationOptions)	Starts a Peek session with the specified options.