PeekSessionCreationOptions Constructor

Definition

Namespace:

Microsoft.VisualStudio.Language.Intellisense

Assembly:

Microsoft.VisualStudio.Language.Intellisense.dll

Package:

Microsoft.VisualStudio.Language.Intellisense v17.12.215

This constructor produces PeekSessionCreationOptions that will create a Peek session using the default sizing behavior.

public PeekSessionCreationOptions (Microsoft.VisualStudio.Text.Editor.ITextView textView, string relationshipName, Microsoft.VisualStudio.Text.ITrackingPoint triggerPoint = default, double? defaultHeight = default, bool allowUserResize = true, Microsoft.VisualStudio.Language.Intellisense.IPeekResizeListener resizeListener = default, bool shouldFocusOnLoad = true);

new Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions : Microsoft.VisualStudio.Text.Editor.ITextView * string * Microsoft.VisualStudio.Text.ITrackingPoint * Nullable<double> * bool * Microsoft.VisualStudio.Language.Intellisense.IPeekResizeListener * bool -> Microsoft.VisualStudio.Language.Intellisense.PeekSessionCreationOptions

Public Sub New (textView As ITextView, relationshipName As String, Optional triggerPoint As ITrackingPoint = Nothing, Optional defaultHeight As Nullable(Of Double) = Nothing, Optional allowUserResize As Boolean = true, Optional resizeListener As IPeekResizeListener = Nothing, Optional shouldFocusOnLoad As Boolean = true)

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.

triggerPoint

ITrackingPoint

The point in the text buffer at which a Peek session is requested. If set to null the current carat position is assumed.

defaultHeight

Nullable<Double>

The default height of the Peek control.

allowUserResize

Boolean

Specifies whether the Peek control resizers should be enabled.

resizeListener

IPeekResizeListener

A callback object that will be notified when the user resizes the Peek control.

shouldFocusOnLoad

Boolean

Specifies whether the Peek control should get focus when it is first loaded.