List CurrentItem (PRIM_MD.ListCurrentItem)

The last item in the list touched either in the UI or via a list related command

Ancestors - Object (PRIM_OBJT)

Details

CurrentItem is the item in the list that was last touched either by the mouse, keyboard or a LANSA list command such as SELECTLIST or GET_ENTRY.
 
When CurrentItem is set, the field values associated with the list definition will be returned to the component. This ensures that the field values for the last item are correct when the event is fired.
 
Care is required when relying on CurrentItem to identify the item last clicked. This will actually be the FocusItem and it won't change until another item is clicked.  CurrentItem however can be affected by a simple MouseOver.
 
Currentitem is best suited to processing directly related the list e.g. DoubleClick events or SELECTLIST.
 
When dealing with actions driven by external sources, for example a button click to process the last item, using FocusItem is recommended.
 
Using the FOR command to iterate over the items in a list will not affect CurrentItem.

Example

Using CurrentItem to set the image for the last item added to a list.
Add_Entry To_List(#List)
#ListCheckBox.CurrentItem.CheckState := Checked
Using CurrentItem in a SELECTLIST loop to hide Read Only Entries.
SelectList Named(#List)
 
    #List.CurrentItem.Visible := (*Not #ReadOnly)
 
EndSelect
Using the FOR command iterates over the items in their sorted sequence, but CurrentItem will not be set.
 
Use GET_ENTRY to set the CurrentItem to ensure field values are returned to the component.
For Each(#Item) in(#List.Items)
 
   Get_Entry Number(#Item.Entry) From_List(#List)
   * User processing here
 
EndFor

Properties

NameDescription
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
HeightThe height of the list item in pixels
HintHint to be shown for the current item
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box
HintTitleHint title to be shown for the current item of the list
LeftPosition of the list item relative to the left boundary of its list
MouseOverStyleStyle applied to the item when mouse over
MouseOverStylesCollection of styles to be applied to the item when mouse over
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
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
StyleStyle to be applied to the current item
StylesCollection of styles to be applied to the current item
ThemeDrawStyleName of the Theme DrawStyle to be applied to the icon
TopPosition of the list item relative to the top boundary of the list
VisibleShow or hide the list item
WidthWidth of the list item in pixels

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