Table of Contents

Property HighlightStates

Namespace
Terminal.Gui.ViewBase
Assembly
Terminal.Gui.dll

HighlightStates

Gets or sets which MouseState changes should cause the View to change its appearance.

public MouseState HighlightStates { get; set; }

Property Value

MouseState

Remarks

In is set by default, which means the View will be highlighted when the mouse is over it. The default behavior of SetAttributeForRole(VisualRole) is to use the Highlight role for the highlight Attribute.

Pressed means the View will be highlighted when the mouse is pressed over it. Border's default behavior is to use the Highlight role when the Border is pressed for Arrangement. Margin's default behavior, when shadows are enabled, is to move the shadow providing a pressed effect.

PressedOutside means the View will be highlighted when the mouse was pressed inside it and then moved outside of it, unless WantContinuousButtonPressed is set to true, in which case the flag has no effect.