Skybound VisualTips

VisualTipDisplayOptions Enumeration

Specifies additional options which affect how a VisualTip is displayed.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

[Visual Basic]
Public Enum VisualTipDisplayOptions
[C#]
public enum VisualTipDisplayOptions

Remarks

The "Position" values specify only a recommended position for a tip. The bounds of the tool area on the screen also help determine where the tip is positioned. For example, if a value of PositionRight is specified, but the tool area falls along the right edge of the screen, the tip will be positioned to the right of the tool area instead.

Each of the "HideOn" values is associated with an event on the source control. When one of the "HideOn" values is specified, and its associated event is raised on the source control, the tip is hidden. For example, if a value of HideOnLostFocus is specified, the tip will be hidden when the control loses the input focus -- that is, when the LostFocus event of the control is raised.

Pressing the Escape key always hides the most recently displayed tip. By default, this key event is not passed through to the source control. When the ForwardEscapeKey value is specified, the key event is passed through.

Members

Member Name Description Value
Default Specifies the default display options. 0
PositionMask The bit mask used to determine the default position of the tip. 3
PositionBottom The tip is positioned below the tool area by default. 0
PositionRight The tip is positioned to the right of the tool area by default. 1
PositionLeft The tip is positioned to the left of the tool area by default. 2
PositionTop The tip is positioned above the tool area by default. 3
HideOnMouseLeave The tip is hidden when the mouse leaves the tool area. Only one tip with this option is displayed on the screen at a time. 8
HideOnKeyDown The tip is hidden when any key is pressed while the source control has the input focus. 16
HideOnKeyPress The tip is hidden when any character key is pressed while the source control has the input focus. 32
HideOnMouseDown The tip is hidden when any mouse button is pressed on the source control. 64
HideOnLostFocus The tip is hidden when the source control loses the input focus. 128
HideOnTextChanged The tip is hidden when the text is changed in the source control. 256
ForwardEscapeKey Forwards the Escape Key event (which hides the tip) through to the source control. 512

Requirements

Namespace: Skybound.VisualTips

Assembly: Skybound.VisualTips (in Skybound.VisualTips.dll)

See Also

Skybound.VisualTips Namespace