Beta Documentation - Subject to change.

The base control class for all available user interface elements.

Methods

  NameDescription
FocusRequest that the control take focus.
GetAllowDropGets if the control supports drop operations from drag and drop.
GetBackColorGets the solid background color of the control.
GetBackColorBlendModeGets the blend mode applied to the background color.
GetBackgroundGets the background graphic of the control.
GetBlendModeGets the blend mode applied to the background image.
GetControlsGets the list of child controls.
GetHeightGets the height of the control.
GetLeftGets the left coordinate of the control.
GetMousePositionGets the mouse position relative to this control.
GetOpacityGets the opacity of the window.
GetParentGets the parent of the control.
GetPositionGets the position of the control.
GetSizeGets the size of the control.
GetTopGets the top coordinate of the window.
GetWantsKeyEventsGets a flag indicating if the control wants to receive key events.
GetWantsUpdatesGets the flag indicating if the control wants to receive Update notifications.
GetWidthGets the width of the control.
GetZOrderGets the Z ordering index of the control.
HasFocusReturns true if the control has focus.
IsAltKeyDownTest if the alt key is pressed.
IsControlKeyDownTest if the control key is pressed.
IsDisplayedGets a flag indicating if the control is displayed.
IsEnabledGets a flag indicating if the control is enabled.
IsMouseVisibleGets a flag indicating if the mouse will see this control.
IsShiftKeyDownTest if the shift key is pressed.
IsVisibleGets a flag indicating if the control is visible.
PointToClientConverts a coordinate from control space to screen space.
PointToScreenConverts a coordinate from control space to screen space.
SetAllowDropSets if the control supports drop operations from drag and drop.
SetBackColorSets the background color of the control.
SetBackColorBlendModeSets the blend mode applied to the background color.
SetBackgroundSets the background image of the control.
SetBlendModeSets the blend mode applied to the background image.
SetEnabledSets a flag indicating if the control is enabled.
SetHeightSets the height of the control.
SetLeftSets the left coordinate of the window.
SetMouseVisibleGets a flag indicating if the mouse will see this control.
SetOpacitySets the opacity of the window.
SetParentSets the parent of the control.
SetPositionSets the position of the control.
SetSizeSets the size of the control.
SetTopSets the top coordinate of the window.
SetVisibleSets the visible flag of a control.
SetWantsKeyEventsSets a flag indicating if the control wants to receive key events.
SetWantsUpdatesSets the flag indicating if the cotnrol wants to receive update notifications.
SetWidthSets the width of the control.
SetZOrderSets the Z order of the control.

Events

  NameDescription
DragDropEvent fired when a drag drop operation is completed.
DragEnterEvent fired when a drag drop operation enters the control.
DragLeaveEvent fired when a drag drop operation leaves the control.
DragStartEvent fired when a drag drop operation starts the control.
EnabledChangedEvent fired when the enabled state of the control changes.
FocusGainedEvent fired when the control gains focus.
FocusLostEvent fired when the control loses focus.
KeyDownEvent fired when a key is pressed down.
KeyUpEvent fired when a key is released.
MouseClickEvent fired when a mouse button is clicked.
MouseDoubleClickEvent fired when a mouse button is double clicked.
MouseDownEvent fired when a mouse button is pressed.
MouseEnterEvent fired when the mouse enters the control.
MouseHoverEvent fired when the mouse is hovering over the control.
MouseLeaveEvent fired when the mouse leaves the cotnrol.
MouseMoveEvent fired when the mouse moves.
MouseUpEvent fired when a mouse button is released.
MouseWheelEvent fired when a mouse wheel moves.
PositionChangedEvent fired when the position of the control changes.
SizeChangedEvent fired when the size of the control changes.
UpdateEvent fired every frame when WantsUpdates is enabled.
VisibleChangedEvent fired when the visible state of the control changes.