Class ControlBase.ControlMouseState

Mouse state based on a specific control.

Inheritance

object

ControlBase.ControlMouseState

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: SadConsole.UI.Controls

Assembly: SadConsole.dll

Syntax

public class ControlBase.ControlMouseState

Constructors

ControlMouseState(ControlBase, MouseScreenObjectState)

Creates an instance of the mouse control state class and infers the MousePosition from the control and state.

Declaration

public ControlMouseState(ControlBase control, MouseScreenObjectState originalMouseState)

Parameters

Type	Name	Description
ControlBase	control	The control.
MouseScreenObjectState	originalMouseState	The original mouse state sent to the control.

ControlMouseState(ControlBase, Point, MouseScreenObjectState)

Creates an instance of the mouse control state class.

Declaration

public ControlMouseState(ControlBase control, Point mousePosition, MouseScreenObjectState originalMouseState)

Parameters

Type	Name	Description
ControlBase	control	The control.
Point	mousePosition	The position of the mouse relative to the control.
MouseScreenObjectState	originalMouseState	The original mouse state sent to the control.

Properties

Control

The control this mouse state is associated with.

Declaration

public ControlBase Control { get; set; }

Property Value

Type	Description
ControlBase

IsMouseOver

When true, indicates the mouse is over the Control; othwerise false.

Declaration

public bool IsMouseOver { get; set; }

Property Value

Type	Description
bool

MousePosition

The relative position of the mouse to the control.

Declaration

public Point MousePosition { get; set; }

Property Value

Type	Description
Point

OriginalMouseState

The original mouse state used to generate the event.

Declaration

public MouseScreenObjectState OriginalMouseState { get; set; }

Property Value

Type	Description
MouseScreenObjectState

Extension Methods

ExtensionsSystem.GetDebuggerDisplayValue(object)