List Button Column Current Item (PRIM_LIST.ButtonCurrentItem)

Provides access to the button for the current list item.

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

Details

Prim_List.Button is a column in a List that is visualized as a pushbutton.
 
Each column type has a corresponding Column class that provides access to the column instance.
 
The button 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 button column is created whenever a Push Button is dragged and dropped from the controls view.

Example

This example shows a single column list updating each button after it's added to the list.
 
When a button is clicked the current item for the column is accessed and the column caption shows which button was clicked.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(456) Width(864)
 
   Define_Com Class(#PRIM_LIST) Name(#List1) Displayposition(1) Left(0) Parent(#COM_OWNER) Tabposition(1) Top(0) Height(369) Width(609)
   Define_Com Class(#PRIM_LIST.Button) Name(#ColumnButton1) Columnwidth(128) Displayposition(1) Parent(#List1)
 
   Evtroutine Handling(#Com_owner.CreateInstance)
 
      Begin_Loop To(10)
 
         Add_Entry To_List(#List1)
 
         #ColumnButton1.CurrentItem.Caption := ("Button &1").substitute( #List1.Items.Itemcount.asstring )
 
      End_Loop
 
   Endroutine
 
   Evtroutine Handling(#ColumnButton1.Click)
 
      #ColumnButton1.ColumnCaption := #ColumnButton1.CurrentItem.caption
 
   Endroutine
 
End_Com

Properties

Name Description
Alignment Position of the caption within the button
Caption Text to be displayed within the control
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)
Ellipses Show ellipses for truncated text
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)
Image Repository enrolled image to show in the control
ImagePosition ImagePosition sets the position of the image relative to caption
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)
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)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020