List Button Column (PRIM_LIST.Button)

Column displaying a button for each item in the list

Ancestors - List Column (PRIM_LIST.Column) 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 CurrentItem class that provides access to the individual entries in the column accessible via the CurrentItem property.
 
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

NameDescription
AlignmentPosition of the caption within the button
CaptionText to be displayed within the control
CellAlignmentPosition of the content of a list cell. Inherited from List Column (PRIM_LIST.Column)
CellHeightHeight of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginBottomBottom margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginLeftLeft margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginRightRight margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginTopTop margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellSizingSizing behavior of a list cell allowing for the content to only use a portion of the cell Inherited from List Column (PRIM_LIST.Column)
CellWidthWidth of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionCaption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionAlignAlignment of the text in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionTextCaption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionWordWrapWrap text on to the next line if there is insufficient space Inherited from List Column (PRIM_LIST.Column)
ColumnImageImage to be show in the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnImageHeightSet the height and width of the column image in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMaxWidthMaximum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMinWidthMinimum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStyleStyle to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStylesCollection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnPinnedPin the column to the left or right hand sides of the list Inherited from List Column (PRIM_LIST.Column)
ColumnPopupPopup Panel to display as a menu Inherited from List Column (PRIM_LIST.Column)
ColumnPopupImageImage to display in the column header in place of the default image Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStyleStyle to be applied to the column header on click Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStylesCollection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnResizeSpecifies whether the column can be manually resized Inherited from List Column (PRIM_LIST.Column)
ColumnStyleStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnStylesCollection of styles to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnThemeDrawStyleName of the Theme DrawStyle to be applied to the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnUnitsSpecifies whether the column is a specific width or uses a proportion of the available space (See ColumnWidth) Inherited from List Column (PRIM_LIST.Column)
ColumnVisibleShow or hide the column Inherited from List Column (PRIM_LIST.Column)
ColumnWidthWidth of the column. See the ColumnUnits property Inherited from List Column (PRIM_LIST.Column)
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)
CurrentItemThe last item in the list touched either in the UI or via a list related command
DisplayPositionPosition of the column relative to the other columns Inherited from List Column (PRIM_LIST.Column)
EllipsesShow ellipses for truncated text
EnabledEnable or disable the column contents Inherited from List Column (PRIM_LIST.Column)
FocusItemReference to the focus item in the column
ImageRepository enrolled image to show in the control
ImagePositionImagePosition sets the position of the image relative to caption
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentReference to the list containing the column Inherited from List Column (PRIM_LIST.Column)
SortAsColumnSpecifies an alternate column to use to sort the data Inherited from List Column (PRIM_LIST.Column)
SortDirectionSort the column ascending or descending Inherited from List Column (PRIM_LIST.Column)
SortPositionPosition of the column in the sort sequence Inherited from List Column (PRIM_LIST.Column)
StyleStyles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
StylesCollection of styles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
ThemeDrawStyleThemeDrawStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column)
VisibleShow or hide the content of a cell Inherited from List Column (PRIM_LIST.Column)

Events

NameDescription
ClickFired when the button is clicked
ColumnClickFired when the column header is clicked Inherited from List Column (PRIM_LIST.Column)
Origin, Handled
ColumnDoubleClickFired when the column header is DoubleClicked Inherited from List Column (PRIM_LIST.Column)
Origin, Handled
ColumnMouseEnterFired when the mouse enters the bounds of the column Inherited from List Column (PRIM_LIST.Column)
ColumnMouseLeaveFired when the mouse leaves the bounds of the column Inherited from List Column (PRIM_LIST.Column)
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from List Column (PRIM_LIST.Column)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List Column (PRIM_LIST.Column)

Methods

NameDescription
SizeToContentsSet the column width to the widest content Inherited from List Column (PRIM_LIST.Column)

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2