ToolTipParameters Constructors
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
ToolTipParameters(Boolean, Boolean, Func<Boolean>) |
Creates a new instance of ToolTipParameters. |
ToolTipParameters(Boolean, Boolean, Func<Boolean>, Boolean, Boolean) |
Creates a new instance of ToolTipParameters. |
Creates a new instance of ToolTipParameters.
public ToolTipParameters (bool trackMouse = true, bool ignoreBufferChange = false, Func<bool> keepOpenFunc = default);
public ToolTipParameters (bool trackMouse, bool ignoreBufferChange, Func<bool> keepOpenFunc);
new Microsoft.VisualStudio.Text.Adornments.ToolTipParameters : bool * bool * Func<bool> -> Microsoft.VisualStudio.Text.Adornments.ToolTipParameters
Public Sub New (Optional trackMouse As Boolean = true, Optional ignoreBufferChange As Boolean = false, Optional keepOpenFunc As Func(Of Boolean) = Nothing)
Public Sub New (trackMouse As Boolean, ignoreBufferChange As Boolean, keepOpenFunc As Func(Of Boolean))
Parameters
- trackMouse
- Boolean
If true, dismisses the tooltip when the mouse leaves the applicable span.
- ignoreBufferChange
- Boolean
If true, and if the tooltip is mouse tracking, does not dismiss when the buffer changes.
A callback function that determines wehther or not to keep open the tooltip in mouse tracking sessions, despite the mouse being outside the tooltip.
Applies to
Creates a new instance of ToolTipParameters.
public ToolTipParameters (bool trackMouse = true, bool ignoreBufferChange = false, Func<bool> keepOpenFunc = default, bool ignoreCaretPositionChange = false, bool dismissWhenOffscreen = true);
new Microsoft.VisualStudio.Text.Adornments.ToolTipParameters : bool * bool * Func<bool> * bool * bool -> Microsoft.VisualStudio.Text.Adornments.ToolTipParameters
Public Sub New (Optional trackMouse As Boolean = true, Optional ignoreBufferChange As Boolean = false, Optional keepOpenFunc As Func(Of Boolean) = Nothing, Optional ignoreCaretPositionChange As Boolean = false, Optional dismissWhenOffscreen As Boolean = true)
Parameters
- trackMouse
- Boolean
If true, dismisses the tooltip when the mouse leaves the applicable span.
- ignoreBufferChange
- Boolean
If true, and if the tooltip is mouse tracking, does not dismiss when the buffer changes.
A callback function that determines wehther or not to keep open the tooltip in mouse tracking sessions, despite the mouse being outside the tooltip.
- ignoreCaretPositionChange
- Boolean
If true, and if the tooltip is span tracking, does not dismiss when the caret position changes.
- dismissWhenOffscreen
- Boolean
If true, and the tooltip is span tracking, dismisses the tooltip if it's scrolled off the screen or focus changes. If false, hides the tooltip in these scenarios, but shows it again when the span is back on the screen.