CheckBox (PRIM_MD.CheckBox)

Check Box is typically used to present a Boolean choice

Ancestors - Control (PRIM_MD.Control) Control (PRIM_CTRL) Object (PRIM_OBJT)

Details

Check box is typically used to present a binary choice e.g. Yes or No, On or Off etc.
 
Positive answers are usually checked while the negative is unchecked.
 
Checkbox also has a third indeterminate Checkstate used to represent more than one answer where the results are conflicting.
 
Unlike the older Windows Checkbox, the checkbox itself will resize as font size changes.

Example

In this example, the Checkstate of the largest Checkbox is evaluated based on a change to either of the two smaller CheckBoxes
Begin_Com Role(*EXTENDS #PRIM_WEB) Theme(#SYS_THEME) Height(592) Width(881)
 
   Define_Com Class(#PRIM_MD.CheckBox) Name(#CheckBox) Caption('Checked') DisplayPosition(1) Height(41) IconHeight(0) Left(24) Parent(#COM_OWNER) TabPosition(1) ThemeDrawStyle('Heading1') Top(24) Width(241) Enabled(False)
   Define_Com Class(#PRIM_MD.CheckBox) Name(#CheckBox1) Caption('Check Box 1') DisplayPosition(2) IconColor(Theme500) Left(24) Parent(#COM_OWNER) TabPosition(2) Top(80) Width(145) Height(33)
   Define_Com Class(#PRIM_MD.CheckBox) Name(#CheckBox2) Caption('Check Box 2') DisplayPosition(3) IconColor(ThemeAccentMedium) Left(24) Parent(#COM_OWNER) TabPosition(3) Top(136) Width(129)
 
   Evtroutine Handling(#CheckBox1.Changed #CheckBox2.Changed)
 
      If (#CheckBox1.CheckState = #CheckBox2.CheckState)
 
         #CheckBox.CheckState := #CheckBox1.CheckState
 
      Else
 
         #CheckBox.CheckState := Grayed
 
      Endif
 
   Endroutine
 
End_Com

Properties

NameDescription
BusyUpdatesBusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParentBusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocusCanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CaptionText to be displayed within the popup
CaptionAlignmentPosition of the caption within the control
CaptionMarginBottomBottom margin in pixels
CaptionMarginLeftLeft margin in pixels
CaptionMarginRightRight margin in pixels
CaptionMarginTopTop margin in pixels
CheckStateCheckState indicates whether a check box is checked
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 Inherited from Control (PRIM_CTRL)
DisplayPositionDisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyleDragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
EllipsesShow ellipses for truncated text
EnabledEnable activates/deactivates the component Inherited from Control (PRIM_CTRL)
FixedPositionFix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
FocusFocus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyleReference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStylesCollection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HeightThe height of the control in pixels Inherited from Control (PRIM_CTRL)
HintCaption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShowEnabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParentDelegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitleHintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
IconAlignmentPosition of the icon within the control
IconColorColor to be applied to the icon
IconHeightHeight of the icon in pixels
IconMarginBottomBottom margin in pixels
IconMarginLeftLeft margin in pixels
IconMarginRightRight margin in pixels
IconMarginTopTop margin in pixels
IsAnimatingIsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealizedTrue if the control is currently realized Inherited from Control (PRIM_CTRL)
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
ModifiedModified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOverMouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyleMouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStylesMouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
NameName identifies the component Inherited from Object (PRIM_OBJT)
OpacityOpacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
PaddingBottomBottom padding in pixels
PaddingLeftLeft padding in pixels
PaddingRightRight padding in pixels
PaddingTopTop padding in pixels
ParentReference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
PopupPopup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenuReference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
RotationRotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeftRotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTopRotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeightScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeftScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTopScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidthScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeftScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTopScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeftLeft position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTopTop position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SkewLeftSkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeftSkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTopSkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTopSkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
StyleStyle defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
StylesCollection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPositionTabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStopSet to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeBackgroundBackground theme to be used Inherited from Control (PRIM_MD.Control)
ThemeDrawStyleName of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
TopPosition of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMoveDetermines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotateDetermines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScaleDetermines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSizeDetermines whether a control can be resized Inherited from Control (PRIM_CTRL)
VisibleShow or hide the control Inherited from Control (PRIM_CTRL)
VisualStyleVisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParentAdopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
WidthWidth of the component in pixels Inherited from Control (PRIM_CTRL)
WordWrapWrap text on to the next line if there is insufficient space

Events

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

Methods

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

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2