IAsyncQuickInfoBroker.TriggerQuickInfoAsync Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Language.Intellisense
Assembly:
Microsoft.VisualStudio.Language.dll
Package:
Microsoft.VisualStudio.Language v17.11.260

Triggers Quick Info tooltip in the specified ITextView at the caret or optional triggerPoint.

public System.Threading.Tasks.Task<Microsoft.VisualStudio.Language.Intellisense.IAsyncQuickInfoSession> TriggerQuickInfoAsync (Microsoft.VisualStudio.Text.Editor.ITextView textView, Microsoft.VisualStudio.Text.ITrackingPoint triggerPoint = default, Microsoft.VisualStudio.Language.Intellisense.QuickInfoSessionOptions options = Microsoft.VisualStudio.Language.Intellisense.QuickInfoSessionOptions.None, System.Threading.CancellationToken cancellationToken = default);
abstract member TriggerQuickInfoAsync : Microsoft.VisualStudio.Text.Editor.ITextView * Microsoft.VisualStudio.Text.ITrackingPoint * Microsoft.VisualStudio.Language.Intellisense.QuickInfoSessionOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Language.Intellisense.IAsyncQuickInfoSession>
Public Function TriggerQuickInfoAsync (textView As ITextView, Optional triggerPoint As ITrackingPoint = Nothing, Optional options As QuickInfoSessionOptions = Microsoft.VisualStudio.Language.Intellisense.QuickInfoSessionOptions.None, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IAsyncQuickInfoSession)

Parameters

textView
ITextView

The ITextView for which Quick Info is to be triggered.

triggerPoint
ITrackingPoint

The ITrackingPoint in the view's text buffer at which Quick Info should be triggered.

options
QuickInfoSessionOptions

Options for customizing Quick Info behavior.

cancellationToken
CancellationToken

If canceled before the method returns, cancels any computations in progress.

Returns

Task<IAsyncQuickInfoSession>

An IAsyncQuickInfoSession tracking the state of the session or null if there are no items.

Exceptions

OperationCanceledException

cancellationToken was canceled by the caller or the operation was interrupted by another call to TriggerQuickInfoAsync(ITextView, ITrackingPoint, QuickInfoSessionOptions, CancellationToken)

Applies to