List Checkbox control (PRIM_MD.ListCheckBox)

Checkbox that is repeated for each entry in the list

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

Details

Prim_MD.ListCheckbox is a Checkbox in a List that is visualized as a checkbox.
 
Each Checkbox type has a corresponding CurrentItem class that provides access to the individual entries accessible via the CurrentItem property.
 
A list checkbox control is created whenever a Check Box is dragged and dropped from the controls view on a list.

Example

This example shows a single control list updating each checkbox CheckState after it's added to the list.
 
When a checkbox is clicked the current checkbox for the item is accessed and the checkbox caption reflects the checkstated of that checkbox.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(241) Width(633) Theme(#SYS_THEME) Layoutmanager(#LayoutPage)
 
    Define_Com Class(#PRIM_TBLO) Name(#LayoutPage)
    Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutPageRow) Displayposition(1) Parent(#LayoutPage)
    Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutPageColumn) Displayposition(1) Parent(#LayoutPage) sizing(FitBoth)
 
    Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutPageItem) Column(#LayoutPageColumn) Manage(#List) Parent(#LayoutPage) Row(#LayoutPageRow)
    Define_Com Class(#PRIM_TBLO) Name(#LayoutList)
    Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutListRow) Parent(#LayoutList) Displayposition(1)
    Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutListColumn) Parent(#LayoutList) Displayposition(1)
    Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutListItem) Column(#LayoutListColumn) Manage(#ListCheckBox) Parent(#LayoutList) Row(#LayoutListRow) Marginbottom(6) Marginleft(6) Marginright(6) Margintop(6) sizing(FitBoth)
 
    Define_Com Class(#prim_md.List) Name(#List) Parent(#COM_OWNER) Displayposition(1) Tabposition(1) Left(0) Top(0) Height(241) Width(633) Layoutmanager(#LayoutList)
    Define_Com Class(#PRIM_MD.ListCheckBox) Name(#ListCheckBox) Caption('Checked') Displayposition(1) Dragstyle(None) Left(0) Parent(#List) Tabposition(1) Top(0) Height(50) Width(633)
 
 
    Evtroutine Handling(#Com_owner.CreateInstance)
 
        Begin_Loop To(10)
 
            Add_Entry To_List(#List)
 
            #ListCheckbox.CurrentItem.CheckState := Checked
 
        End_Loop
 
    Endroutine
 
 
    Evtroutine Handling(#ListCheckbox.Changed)
 
        #ListCheckbox.CurrentItem.Caption := #ListCheckbox.CurrentItem.CheckState
 
    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 Inherited from CheckBox (PRIM_MD.CheckBox)
CaptionAlignmentPosition of the caption within the control Inherited from CheckBox (PRIM_MD.CheckBox)
CaptionMarginBottomBottom margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
CaptionMarginLeftLeft margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
CaptionMarginRightRight margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
CaptionMarginTopTop margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
CheckStateCheckState indicates whether a check box is checked Inherited from CheckBox (PRIM_MD.CheckBox)
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)
CurrentItemThe last item in the list touched either in the UI or via a list related command
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 Inherited from CheckBox (PRIM_MD.CheckBox)
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)
FocusItemReference to the check box in the focus entry of the list
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 Inherited from CheckBox (PRIM_MD.CheckBox)
IconColorColor to be applied to the icon Inherited from CheckBox (PRIM_MD.CheckBox)
IconHeightHeight of the icon in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
IconMarginBottomBottom margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
IconMarginLeftLeft margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
IconMarginRightRight margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
IconMarginTopTop margin in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
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 Inherited from CheckBox (PRIM_MD.CheckBox)
PaddingLeftLeft padding in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
PaddingRightRight padding in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
PaddingTopTop padding in pixels Inherited from CheckBox (PRIM_MD.CheckBox)
ParentReference to the prim_md.list containing the control
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)
SourceName of the repository field used to define and store the data for this control
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 Inherited from CheckBox (PRIM_MD.CheckBox)

Events

NameDescription
AnimationEndedFired when an animation is ended Inherited from CheckBox (PRIM_MD.CheckBox)
Cancelled
ChangedFired when the value is changed Inherited from CheckBox (PRIM_MD.CheckBox)
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
GotFocusFired when the control receives focus Inherited from CheckBox (PRIM_MD.CheckBox)
InitializeFired after a component has been realized for the first time Inherited from CheckBox (PRIM_MD.CheckBox)
LostFocusFired when the control loses focus 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)
SizeTo Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
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

EPC1420030 V14sp2 November 2018