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

Name

Description

BusyUpdates

BusyUpdates specifies how the control updates itself

BusyUpdatesOfParent

BusyUpdatesOfParent specifies whether the parent controls updates

CanFocus

CanFocus returns a value indicating whether the control can receive keyboard focus

ComponentClassName

ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)

ComponentMembers

ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)

ComponentPatternName

ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)

ComponentTag

Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)

ComponentType

ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)

ComponentTypeName

ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)

Cursor

Cursor sets the cursor image

DisplayPosition

DisplayPosition determines the order in which components are shown

DragStyle

DragStyle determines how a component can be dragged

Enabled

Enable activates/deactivates the component

FixedPosition

Fix the control position so that it does not move if the parent is scrolled

Focus

Focus tells whether the component has focus

FocusedStyle

Reference to a style to be applied when the control is focus

FocusedStyles

Collection of styles to be applied when the control is focus

Handle

Returns the Windows handle in desktop applications

Height

The height of the control in pixels

Hint

Caption displayed when the mouse hovers over the control

HintPopup

HintPopup allows a PopupPanel instance to be used instead of the default hint text box

HintShow

Enabled or disable the appearance of hints

HintShowOfParent

Delegate hints appearance to the parent control

HintTitle

HintTitle defines the text shown at the top of the hint window in emphasized text

IsAnimating

IsAnimating indicates that a control is currently being animated

IsRealized

True if the control is currently realized

Left

Position of the control relative to the left boundary of its parent

Modified

Modified indicates that the contents of the component have changed

MouseOver

MouseOver determines whether the mouse is directly over a control

MouseOverStyle

MouseOverStyle defines the style to be applied to a control when the mouse is over it

MouseOverStyles

MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it

Name

Name identifies the component Inherited from Object (PRIM_OBJT)

Opacity

Opacity denotes the appearance of a control in terms of its interaction with its background

Owner

Owner owns this component Inherited from Object (PRIM_OBJT)

Parent

Reference to the control in which this control is visually positioned

Popup

Popup allows a PopupPanel instance to be used instead of the typical right click popup menu

PopupMenu

Reference to a PopupMenu to be shown on a right click

Rotation

Rotation allows a control to rotate a number of degrees about a given origin

RotationOriginLeft

RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate

RotationOriginTop

RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate

ScaleHeight

ScaleHeight is the percentage of the height to use in the visual appearance of a control

ScaleOriginLeft

ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale

ScaleOriginTop

ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale

ScaleWidth

ScaleWidth is the percentage of the width to use in the visual appearance of a control

ScreenLeft

ScreenLeft sets the distance from the left of the screen

ScreenTop

ScreenTop sets the distance from the top of the screen

ScrollLeft

Left position of a horizontally scrolled child control relative to its parent control

ScrollTop

Top position of a vertically scrolled child control relative to its parent control

SkewLeft

SkewLeft defines the angle at which to skew the control horizontally

SkewOriginLeft

SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew

SkewOriginTop

SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew

SkewTop

SkewTop defines the angle at which to skew the control vertically

Style

Style defines the style to be applied to a control

Styles

Collection of styles to be applied to the control

TabPosition

TabPosition sets the order of focus when the Tab key is used

TabStop

Set to false to stop focus being given to the control via the Tab key

ThemeDrawStyle

Name of the Theme DrawStyle to be applied to the control

Top

Position of the control relative to the top boundary of its parent

TouchMove

Determines how the control will respond to touch move processing

TouchRotate

Determines how the control will respond to touch rotation

TouchScale

Determines how the control will respond to touch scaling

TouchSize

Determines whether a control can be resized

Visible

Show or hide the control

VisualStyle

VisualStyle sets the appearance

VisualStyleOfParent

Adopt the Visual style from the parent control

Width

Width of the component in pixels

Events

Name

Description

AnimationEnded

Fired when an animation is ended

Cancelled

CreateInstance

CreateInstance is signaled when an instance of a component is created [Inherited from Control (PRIM_CTRL)

DestroyInstance

DestroyInstance is signaled when an instance of a component is about to be destroyed [Inherited from Control (PRIM_CTRL)

DragDrop

Fired on mouse up to signify the end of a drag process

PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult

DragOver

Fired during the drag and drop process when the cursor moves over the control

PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled

EndDrag

Fired when the drag and drop process has completed

Source, Payload, DragResult, AggregatedSource, Origin, Handled

Initialize

Fired after a component has been realized for the first time

MouseEnter

The mouse has entered the bounds of the control

MouseHover

The mouse has hovered over the control

Origin, Handled

MouseLeave

The mouse has left the bounds of the control

StartDrag

Fired when the user starts a drag and drop process

Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled

TouchChange

Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events

MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue

TouchEnd

Fired when the user stops touching the screen

TouchStart

Fired when the user first makes physical contact with the screen

Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name

Description

FadeIn

Animate from invisible to visible

Duration, Delay

FadeOut

Animate from visible to invisible

Duration, Delay, Visible

MoveFrom

Move a control from the specified position to the current position

Left, Top, Duration, Delay

MoveTo

Animate a move from the specified number of pixels

Left, Top, Duration, Delay

Realize

Creates the visual portion of dynamically created controls

Scale

Animate a change of scale

ScaleWidth, ScaleHeight, Duration, Delay

SetFocus

Sets the control to be the focus control

ShowMessages

LANSA Internal Use

SizeTo

Animate a change of size

Width, Height, Duration, Delay

Unrealize

Destroys the visual portion of dynamically created controls

UpdateDisplay

UpdateDisplay updates the display immediately


See also

All Component Classes

Technical Reference

  • No labels