Control (PRIM_CTRL)

Base class for all visual controls

Ancestors - Object (PRIM_OBJT)

Details

A Control is the base class for nearly all visible component features such as Panel, label, button etc.

Properties

NameDescription
BusyUpdatesBusyUpdates specifies how the control updates itself
BusyUpdatesOfParentBusyUpdatesOfParent specifies whether the parent controls updates
CanFocusCanFocus returns a value indicating whether the control can receive keyboard focus
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
CursorCursor sets the cursor image
DisplayPositionDisplayPosition determines the order in which components are shown
DragStyleDragStyle determines how a component can be dragged
EnabledEnable activates/deactivates the component
FixedPositionFix the control position so that it does not move if the parent is scrolled
FocusFocus tells whether the component has focus
FocusedStyleReference to a style to be applied when the control is focus
FocusedStylesCollection of styles to be applied when the control is focus
HandleReturns the Windows handle in desktop applications
HeightThe height of the control in pixels
HintCaption displayed when the mouse hovers over the control
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box
HintShowEnabled or disable the appearance of hints
HintShowOfParentDelegate hints appearance to the parent control
HintTitleHintTitle defines the text shown at the top of the hint window in emphasized text
IsAnimatingIsAnimating indicates that a control is currently being animated
IsRealizedTrue if the control is currently realized
LeftPosition of the control relative to the left boundary of its parent
ModifiedModified indicates that the contents of the component have changed
MouseOverMouseOver determines whether the mouse is directly over a control
MouseOverStyleMouseOverStyle defines the style to be applied to a control when the mouse is over it
MouseOverStylesMouseOverStyles is a collection of styles to be applied to a control when the mouse is over it
NameName identifies the component Inherited from Object (PRIM_OBJT)
OpacityOpacity denotes the appearance of a control in terms of its interaction with its background
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentReference to the control in which this control is visually positioned
PopupPopup allows a PopupPanel instance to be used instead of the typical right click popup menu
PopupMenuReference to a PopupMenu to be shown on a right click
RotationRotation allows a control to rotate a number of degrees about a given origin
RotationOriginLeftRotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate
RotationOriginTopRotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate
ScaleHeightScaleHeight is the percentage of the height to use in the visual appearance of a control
ScaleOriginLeftScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale
ScaleOriginTopScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale
ScaleWidthScaleWidth is the percentage of the width to use in the visual appearance of a control
ScreenLeftScreenLeft sets the distance from the left of the screen
ScreenTopScreenTop sets the distance from the top of the screen
ScrollLeftLeft position of a horizontally scrolled child control relative to its parent control
ScrollTopTop position of a vertically scrolled child control relative to its parent control
SkewLeftSkewLeft defines the angle at which to skew the control horizontally
SkewOriginLeftSkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew
SkewOriginTopSkewOriginTop defines the top coordinate of an imaginary point from which a control will skew
SkewTopSkewTop defines the angle at which to skew the control vertically
StyleStyle defines the style to be applied to a control
StylesCollection of styles to be applied to the control
TabPositionTabPosition sets the order of focus when the Tab key is used
TabStopSet to false to stop focus being given to the control via the Tab key
ThemeDrawStyleName of the Theme DrawStyle to be applied to the control
TopPosition of the control relative to the top boundary of its parent
TouchMoveDetermines how the control will respond to touch move processing
TouchRotateDetermines how the control will respond to touch rotation
TouchScaleDetermines how the control will respond to touch scaling
TouchSizeDetermines whether a control can be resized
VisibleShow or hide the control
VisualStyleVisualStyle sets the appearance
VisualStyleOfParentAdopt the Visual style from the parent control
WidthWidth of the component in pixels

Events

NameDescription
AnimationEndedFired when an animation is ended
Cancelled
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DragDropFired on mouse up to signify the end of a drag process
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOverFired during the drag and drop process when the cursor moves over the control
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDragFired when the drag and drop process has completed
Source, Payload, DragResult, AggregatedSource, Origin, Handled
InitializeFired after a component has been realized for the first time
MouseEnterThe mouse has entered the bounds of the control
MouseHoverThe mouse has hovered over the control
Origin, Handled
MouseLeaveThe mouse has left the bounds of the control
StartDragFired when the user starts a drag and drop process
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChangeFired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEndFired when the user stops touching the screen
TouchStartFired when the user first makes physical contact with the screen
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

NameDescription
FadeInAnimate from invisible to visible
Duration, Delay
FadeOutAnimate from visible to invisible
Duration, Delay, Visible
MoveFromMove a control from the specified position to the current position
Left, Top, Duration, Delay
MoveToAnimate a move from the specified number of pixels
Left, Top, Duration, Delay
RealizeCreates the visual portion of dynamically created controls
ScaleAnimate a change of scale
ScaleWidth, ScaleHeight, Duration, Delay
SetFocusSets the control to be the focus control
ShowMessagesLANSA Internal Use
UnrealizeDestroys the visual portion of dynamically created controls
UpdateDisplayUpdateDisplay updates the display immediately

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2