List Current Item

List Current Item (PRIM_LIST.CurrentItem)

Base class for all Prim_List CurrentItem classes

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)
#List.CurrentItem.Image <= #Image1

Using CurrentItem in a SELECTLIST loop to check item state. Here the selected items in the list are being totalled.

SelectList Named(#List)
Continue (*Not #Item.Selected)
 
   #TotalSalary += #Salary
 
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

Name	Description
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
Hint	Hint to be shown for the current column/item
HintPopup	HintPopup to be shown for the current column/item
HintTitle	Hint title to be shown for the current column/item
MouseOverStyle	Style to be applied when the mouse enters the current column/item
MouseOverStyles	Collection of styles to be applied when the mouse enters the current column/item
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
Style	Style to be applied to the current column/item
Styles	Collection of styles to be applied to the current column/item
ThemeDrawStyle	ThemeDrawStyle to be applied to the current item in the column
Visible	Show or hide the list item

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

Details

Example

Properties

Events

Methods

See also