IPeekBroker.TriggerPeekSession Method

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.11.260

Overloads

TriggerPeekSession(PeekSessionCreationOptions)	Starts a Peek session with the specified options.
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(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(PeekSessionCreationOptions)

Starts a Peek session with the specified options.

public:
 Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ TriggerPeekSession(Microsoft::VisualStudio::Language::Intellisense::PeekSessionCreationOptions ^ options);

Microsoft::VisualStudio::Language::Intellisense::IPeekSession TriggerPeekSession(Microsoft::VisualStudio::Language::Intellisense::PeekSessionCreationOptions const & options);

public Microsoft.VisualStudio.Language.Intellisense.IPeekSession TriggerPeekSession (Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions options);

abstract member TriggerPeekSession : Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions -> Microsoft.VisualStudio.Language.Intellisense.IPeekSession

Public Function TriggerPeekSession (options As PeekSessionCreationOptions) As IPeekSession

Parameters

options

PeekSessionCreationOptions

The options needed to create a Peek session.

Returns

IPeekSession

A valid Peek session. May be null if no session could be created for the TriggerPoint for the given RelationshipName.

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.

public:
 Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, System::String ^ relationshipName);

public:
 Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Platform::String ^ relationshipName);

Microsoft::VisualStudio::Language::Intellisense::IPeekSession TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView const & textView, std::wstring const & relationshipName);

public Microsoft.VisualStudio.Language.Intellisense.IPeekSession TriggerPeekSession (Microsoft.VisualStudio.Text.Editor.ITextView textView, string relationshipName);

abstract member TriggerPeekSession : Microsoft.VisualStudio.Text.Editor.ITextView * string -> Microsoft.VisualStudio.Language.Intellisense.IPeekSession

Public Function TriggerPeekSession (textView As ITextView, relationshipName As String) As IPeekSession

Parameters

textView

ITextView

The ITextView over which to trigger a Peek session.

relationshipName

String

The name of the requested relationship to be explored by a Peek session.

Returns

IPeekSession

A valid Peek session. May be null if no session could be created at the caret position for the given relationship.

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.

public:
 Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Microsoft::VisualStudio::Text::ITrackingPoint ^ triggerPoint, System::String ^ relationshipName);

public:
 Microsoft::VisualStudio::Language::Intellisense::IPeekSession ^ TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Microsoft::VisualStudio::Text::ITrackingPoint ^ triggerPoint, Platform::String ^ relationshipName);

Microsoft::VisualStudio::Language::Intellisense::IPeekSession TriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView const & textView, Microsoft::VisualStudio::Text::ITrackingPoint const & triggerPoint, std::wstring const & relationshipName);

public Microsoft.VisualStudio.Language.Intellisense.IPeekSession TriggerPeekSession (Microsoft.VisualStudio.Text.Editor.ITextView textView, Microsoft.VisualStudio.Text.ITrackingPoint triggerPoint, string relationshipName);

abstract member TriggerPeekSession : Microsoft.VisualStudio.Text.Editor.ITextView * Microsoft.VisualStudio.Text.ITrackingPoint * string -> Microsoft.VisualStudio.Language.Intellisense.IPeekSession

Public Function TriggerPeekSession (textView As ITextView, triggerPoint As ITrackingPoint, relationshipName As String) As IPeekSession

Parameters

textView

ITextView

The ITextView over which to trigger a Peek session.

triggerPoint

ITrackingPoint

The point in the text buffer at which a Peek session is requested.

relationshipName

String

The name of the requested relationship to be explored by a Peek session.

Returns

IPeekSession

A valid Peek session. May be null if no session could be created at the trigger point for the given relationship.