List CheckBox Current Item (PRIM_LIST.CheckBoxCurrentItem)

Provides access to the check box for the current list item.

Ancestors - List Current Item (PRIM_LIST.CurrentItem)Object (PRIM_OBJT)

Details

Prim_List.Checkbox is a column in a List that is visualized as a checkbox.

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

The checkbox for each item can be modified independently using the current item for the column in the same way that other visual LANSA lists allow the current item for the list to be used.

A checkbox column is created whenever a Check Box is dragged and dropped from the controls view.

Example

This example shows a single column list updating each checkbox after it's added to the list.

When a checkbox is clicked the current item for the column is accessed and the column caption shows which checkbox was clicked.

     Begin_Com Role(*EXTENDS #PRIM_WEB) 

        Define_Com Class(#PRIM_LIST) Name(#List1) Displayposition(1) Left(24) Parent(#COM_OWNER) Tabposition(1) Top(24) Height(337) Width(609)
        Define_Com Class(#PRIM_LIST.checkbox) Name(#ColumnCheckbox1) Columnwidth(128) Displayposition(1) Parent(#List1) 

        Evtroutine Handling(#Com_owner.CreateInstance) 

           Begin_Loop To(10) 

              Add_Entry To_List(#List1) 

           #ColumnCheckbox1.CurrentItem.ButtonState := Checked 

           End_Loop 

        Endroutine 

        Evtroutine Handling(#ColumnCheckbox1.Click) 

           #ColumnCheckbox1.ColumnCaption := #ColumnCheckbox1.CurrentItem.ButtonState 

        Endroutine 

     End_Com

Properties

Name	Description
ButtonState	ButtonState indicates whether a check box is checked
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)
Enabled	Enable or disable the list item Inherited from List Current Item (PRIM_LIST.CurrentItem)
Hint	Hint to be shown for the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
HintPopup	HintPopup to be shown for the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
HintTitle	Hint title to be shown for the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
MouseOverStyle	Style to be applied when the mouse enters the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
MouseOverStyles	Collection of styles to be applied when the mouse enters the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
Name	Name identifies the component Inherited from Object (PRIM_OBJT)
Owner	Owner owns this component Inherited from Object (PRIM_OBJT)
Parent	The 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)
Popup	Popup to be shown for the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
ReadOnly	ReadOnly controls whether the cell can be used for input
Style	Style to be applied to the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
Styles	Collection of styles to be applied to the current column/item Inherited from List Current Item (PRIM_LIST.CurrentItem)
ThemeDrawStyle	ThemeDrawStyle to be applied to the current item in the column Inherited from List Current Item (PRIM_LIST.CurrentItem)
Visible	Show or hide the list item Inherited from List Current Item (PRIM_LIST.CurrentItem)

Events

Name	Description
CreateInstance	CreateInstance is signalled when an instance of a component is created Inherited from List Current Item (PRIM_LIST.CurrentItem)
DestroyInstance	DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List Current Item (PRIM_LIST.CurrentItem)

Methods

Name	Description
SetFocus	Sets focus to the currentitem in the list Inherited from List Current Item (PRIM_LIST.CurrentItem)