List CheckBox Column CurrentItem (PRIM_MD.ListCheckBoxCurrentItem)

Provides access to the checkbox of the current list item

Ancestors - List CurrentItem (PRIM_MD.ListCurrentItem) Object (PRIM_OBJT)

Details

Prim_MD.ListCheckBox is a control List that is visualized as a CheckBox.

Each control type has a corresponding control class that provides access to the control instance.

The CheckBox for each item can be modified independently using the current item for the control in the same way that other visual LANSA lists allow the current item for the list to be used.
 
A CheckBox control is created whenever a CheckBox is dragged and dropped from the controls view.

Example

This example shows a single control list updating each button after it's added to the list.
 
When a CheckBox is changed the current item for the control is accessed and the caption shows check state.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(456) Width(864) Layoutmanager(#Layout1)

    Define_Com Class(#PRIM_TBLO) Name(#Layout1)
    Define_Com Class(#PRIM_TBLO.Row) Name(#Layout1Row1) Displayposition(1) Parent(#Layout1)
    Define_Com Class(#PRIM_TBLO.Column) Name(#Layout1Column1) Displayposition(1) Parent(#Layout1)
    Define_Com Class(#PRIM_TBLO.Item) Name(#Layout1Item1) Column(#Layout1Column1) Manage(#List) Parent(#Layout1) Row(#Layout1Row1)
    Define_Com Class(#PRIM_TBLO) Name(#Layout2)
    Define_Com Class(#PRIM_TBLO.Row) Name(#Layout2Row1) Displayposition(1) Parent(#Layout2)
    Define_Com Class(#PRIM_TBLO.Column) Name(#Layout2Column1) Displayposition(1) Parent(#Layout2)
    Define_Com Class(#PRIM_TBLO.Item) Name(#Layout2Item1) Column(#Layout2Column1) Parent(#Layout2) Row(#Layout2Row1)

    Define_Com Class(#PRIM_MD.List) Name(#List) Displayposition(1) Left(0) Parent(#COM_OWNER) Tabposition(1) Top(0) Height(456) Width(864) Layoutmanager(#Layout2)
    Define_Com Class(#PRIM_MD.ListCheckBox) Name(#ListCheckBox) Parent(#List) Displayposition(1) Tabposition(1) Left(0) Top(0) Width(864) Source(#xDemoNumber)

        Evtroutine Handling(#Com_owner.CreateInstance)

            Begin_Loop Using(#xDemoNumber) To(10)

                Add_Entry To_List(#List)

                #ListCheckBox.CurrentItem.Caption := ('Check State = &1').Substitute( #ListCheckBox.CurrentItem.CheckState )

            End_Loop
        Endroutine

        Evtroutine Handling(#ListCheckBox.Changed)

            #ListCheckBox.CurrentItem.Caption := ('Check State = &1').Substitute( #ListCheckBox.CurrentItem.CheckState )

        Endroutine

End_Com

Properties

NameDescription
CaptionText to be shown within the control
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)
EnabledEnable or disable the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HeightThe height of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintHint to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintTitleHint title to be shown for the current item of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
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
LeftPosition of the list item relative to the left boundary of its list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MouseOverStyleStyle applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MouseOverStylesCollection of styles to be applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
NameName identifies the component Inherited from Object (PRIM_OBJT)
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
ParentThe component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
PopupPopup to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
StyleStyle to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
StylesCollection of styles to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
ThemeDrawStyleName of the Theme DrawStyle to be applied to the icon Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
TopPosition of the list item relative to the top boundary of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
VisibleShow or hide the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
WidthWidth of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)

Events

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2