ToolTipParameters Constructors

Definition

Overloads

ToolTipParameters(Boolean, Boolean, Func<Boolean>)

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);

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.

keepOpenFunc
Func<Boolean>

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

ToolTipParameters(Boolean, Boolean, Func<Boolean>, Boolean, Boolean)

Creates a new instance of ToolTipParameters.

public ToolTipParameters (bool trackMouse = true, bool ignoreBufferChange = false, Func<bool> keepOpenFunc = default, bool ignoreCaretPositionChange = false, bool dismissWhenOffscreen = 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.

keepOpenFunc
Func<Boolean>

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.

Applies to