IPeekBroker.CanTriggerPeekSession Method

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.12.215

Overloads

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

public:
 bool CanTriggerPeekSession(Microsoft::VisualStudio::Language::Intellisense::PeekSessionCreationOptions ^ options, Predicate<System::String ^> ^ isStandaloneFilePredicate);

public bool CanTriggerPeekSession (Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions options, Predicate<string> isStandaloneFilePredicate);

abstract member CanTriggerPeekSession : Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions * Predicate<string> -> bool

Public Function CanTriggerPeekSession (options As PeekSessionCreationOptions, isStandaloneFilePredicate As Predicate(Of String)) As Boolean

Parameters

options

PeekSessionCreationOptions

The options needed to create a Peek session.

isStandaloneFilePredicate

Predicate<String>

A predicate used to determine whether given file is a standalone (not part of a project) file.

Returns

Boolean

true if a Peek session can be triggered at the position, false otherwise.

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.

public:
 bool CanTriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, System::String ^ relationshipName, Predicate<System::String ^> ^ isStandaloneFilePredicate);

public bool CanTriggerPeekSession (Microsoft.VisualStudio.Text.Editor.ITextView textView, string relationshipName, Predicate<string> isStandaloneFilePredicate);

abstract member CanTriggerPeekSession : Microsoft.VisualStudio.Text.Editor.ITextView * string * Predicate<string> -> bool

Public Function CanTriggerPeekSession (textView As ITextView, relationshipName As String, isStandaloneFilePredicate As Predicate(Of String)) As Boolean

Parameters

textView

ITextView

The ITextView over which to check if a Peek session can be triggered.

relationshipName

String

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

isStandaloneFilePredicate

Predicate<String>

A predicate used to determine whether given file is a standalone (not part of a project) file.

Returns

Boolean

true if a Peek session can be triggered at the caret position, false otherwise.

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.

public:
 bool CanTriggerPeekSession(Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, Microsoft::VisualStudio::Text::ITrackingPoint ^ triggerPoint, System::String ^ relationshipName, Predicate<System::String ^> ^ isStandaloneFilePredicate);

public bool CanTriggerPeekSession (Microsoft.VisualStudio.Text.Editor.ITextView textView, Microsoft.VisualStudio.Text.ITrackingPoint triggerPoint, string relationshipName, Predicate<string> isStandaloneFilePredicate);

abstract member CanTriggerPeekSession : Microsoft.VisualStudio.Text.Editor.ITextView * Microsoft.VisualStudio.Text.ITrackingPoint * string * Predicate<string> -> bool

Public Function CanTriggerPeekSession (textView As ITextView, triggerPoint As ITrackingPoint, relationshipName As String, isStandaloneFilePredicate As Predicate(Of String)) As Boolean

Parameters

textView

ITextView

The ITextView over which to check if a Peek session can be triggered.

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.

isStandaloneFilePredicate

Predicate<String>

A predicate used to determine whether given file is a standalone (not part of a project) file.

Returns

Boolean

true if a Peek session can be triggered at the position, false otherwise.