IPeekBroker Interface

Visual Studio 2015
 

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

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

public interface IPeekBroker

NameDescription
System_CAPS_pubmethodCanTriggerPeekSession(ITextView, ITrackingPoint, 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.

System_CAPS_pubmethodCanTriggerPeekSession(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.

System_CAPS_pubmethodCanTriggerPeekSession(PeekSessionCreationOptions, 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.

System_CAPS_pubmethodCreatePeekSession(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.

System_CAPS_pubmethodCreatePeekSession(PeekSessionCreationOptions)

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.

System_CAPS_pubmethodDismissPeekSession(ITextView)

Dismisses an active Peek session for a particular ITextView.

System_CAPS_pubmethodGetPeekSession(ITextView)

Gets the active Peek session.

System_CAPS_pubmethodIsPeekSessionActive(ITextView)

Determines whether or not a Peek session is active over the specified ITextView.

System_CAPS_pubmethodTriggerNestedPeekSession(ITextView, ITrackingPoint, 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.

System_CAPS_pubmethodTriggerNestedPeekSession(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.

System_CAPS_pubmethodTriggerNestedPeekSession(PeekSessionCreationOptions, 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.

System_CAPS_pubmethodTriggerPeekSession(ITextView, ITrackingPoint, String)

Starts a Peek session, assuming the caret position to be the position of a peekable symbol on which a Peek session is requested.

System_CAPS_pubmethodTriggerPeekSession(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.

System_CAPS_pubmethodTriggerPeekSession(PeekSessionCreationOptions)

Starts a Peek session, assuming the caret position to be the position of a peekable symbol n which a Peek session is requested.

This is a MEF component, and should be imported as follows:

[Import]
IPeekBroker peekBroker = null;
Return to top
Show: