List String Column (PRIM_LIST.String)

Column displaying text

Ancestors - List Column (PRIM_LIST.Column)Object (PRIM_OBJT)

Details

Prim_List.String is a column in a List used to display alphanumeric data.
 
Each column type has a corresponding CurrentItem class that provides access to the individual entries in the column accessible via the CurrentItem property.
 
The entry field 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 string column is created whenever an alphanumeric field is dropped on the list. The Source property will be set to the field and it will be used as a column in the underlying working list.

Example

This example shows a list with one number and one string column.
 
After an entry is added, the current string column cell is hidden if the number is odd.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(456) Width(864)
 
   Define_Com Class(#PRIM_LIST) Name(#List1) Displayposition(1) Left(16) Parent(#COM_OWNER) Tabposition(1) Top(8) Height(425) Width(809)
   Define_Com Class(#PRIM_LIST.Number) Name(#ColumnXDEMONUMB1) Displayposition(1) Increment(1) Parent(#List1) Source(#xDemoNumber) Wrap(False) Columnreadonly(False)
   Define_Com Class(#PRIM_LIST.String) Name(#ColumnXDEMOALPH1) Displayposition(2) Parent(#List1) Source(#xDemoAlpha128)
 
   Evtroutine Handling(#Com_owner.CreateInstance)
 
      Begin_Loop To(10)
 
         #xDemoNumber += 1
         #xDemoAlpha128 := #xDemoNumber.Asstring
 
         Add_Entry To_List(#List1)
         #ColumnXDEMOALPH1.CurrentItem.Visible := (#xDemoNumber.mod( 2 ) = 0)
 
      End_Loop
 
   Endroutine
 
End_Com

Properties

Name Description
AutoSelect Automatically select the text when the control receives focus
CellAlignment Position of the content of a list cell. Inherited from List Column (PRIM_LIST.Column)
CellHeight Height of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginBottom Bottom margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginLeft Left margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginRight Right margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellMarginTop Top margin of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CellSizing Sizing behavior of a list cell allowing for the content to only use a portion of the cell Inherited from List Column (PRIM_LIST.Column)
CellThemeDrawStyle Drawstyle for list cell
CellWidth Width of the cell in pixels when not overridden by CellSizing Inherited from List Column (PRIM_LIST.Column)
CharacterCase CharacterCase sets character case
ColumnCaption Caption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionAlign Alignment of the text in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionText Caption displayed in the column header Inherited from List Column (PRIM_LIST.Column)
ColumnCaptionType Type of caption to appear in the column header
ColumnCaptionWordWrap Wrap text on to the next line if there is insufficient space Inherited from List Column (PRIM_LIST.Column)
ColumnImage Image to be show in the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnImageHeight Set the height and width of the column image in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMaxWidth Maximum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMinWidth Minimum allow width of the column in pixels Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStyle Style to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnMouseOverStyles Collection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnPinned Pin the column to the left or right hand sides of the list Inherited from List Column (PRIM_LIST.Column)
ColumnPopup Popup Panel to display as a menu Inherited from List Column (PRIM_LIST.Column)
ColumnPopupImage Image to display in the column header in place of the default image Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStyle Style to be applied to the column header on click Inherited from List Column (PRIM_LIST.Column)
ColumnPressedStyles Collection of styles to be applied to the column header on mouseOver Inherited from List Column (PRIM_LIST.Column)
ColumnReadOnly Specifies whether the column is input capable
ColumnResize Specifies whether the column can be manually resized Inherited from List Column (PRIM_LIST.Column)
ColumnStyle Style to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnStyles Collection of styles to be applied to the column Inherited from List Column (PRIM_LIST.Column)
ColumnThemeDrawStyle Name of the Theme DrawStyle to be applied to the column heading Inherited from List Column (PRIM_LIST.Column)
ColumnUnits Specifies whether the column is a specific width or uses a proportion of the available space (See ColumnWidth) Inherited from List Column (PRIM_LIST.Column)
ColumnVisible Show or hide the column Inherited from List Column (PRIM_LIST.Column)
ColumnWidth Width of the column. See the ColumnUnits property Inherited from List Column (PRIM_LIST.Column)
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)
CurrentItem The last item in the list touched either in the UI or via a list related command
DisplayAlignment DisplayAlignment sets edit box alignment when not in focus
DisplayPosition Position of the column relative to the other columns Inherited from List Column (PRIM_LIST.Column)
EditAlignment EditAlignment sets the alignment of the text when in focus
Enabled Enable or disable the column contents Inherited from List Column (PRIM_LIST.Column)
FocusItem Reference to the focus item in the column
MaxLength MaxLength sets the maximum number of characters
Name Name identifies the component Inherited from Object (PRIM_OBJT)
NumericEditStyle NumericEditStyle controls insert and overtype data entry styles for numbers
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent Reference to the list containing the column Inherited from List Column (PRIM_LIST.Column)
PasswordChar Character to use to mask the data being entered
PrompterImage Image used to override the default file prompter image
ShowPrompter Show or hide the prompter
SortAsColumn Specifies an alternate column to use to sort the data Inherited from List Column (PRIM_LIST.Column)
SortDirection Sort the column ascending or descending Inherited from List Column (PRIM_LIST.Column)
SortOnClick Sort the column when the column header is clicked
SortPosition Position of the column in the sort sequence Inherited from List Column (PRIM_LIST.Column)
Source Name of the repository field used to define and store the data for this column
Style Styles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
Styles Collection of styles to be applied to the item Inherited from List Column (PRIM_LIST.Column)
ThemeDrawStyle ThemeDrawStyle to be applied to the column Inherited from List Column (PRIM_LIST.Column)
Visible Show or hide the content of a cell Inherited from List Column (PRIM_LIST.Column)
WordWrap Wrap text on to the next line if there is insufficient space

Events

Name Description
AutoCompleting Fired as a value is being edited allowing for a replacement value to be returned
Value
Click Fired when the mouse is clicked on the control
ColumnClick Fired when the column header is clicked Inherited from List String Column (PRIM_LIST.String)
Origin, Handled
ColumnDoubleClick Fired when the column header is DoubleClicked Inherited from List String Column (PRIM_LIST.String)
Origin, Handled
ColumnMouseEnter Fired when the mouse enters the bounds of the column Inherited from List String Column (PRIM_LIST.String)
ColumnMouseLeave Fired when the mouse leaves the bounds of the column Inherited from List String Column (PRIM_LIST.String)
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from List String Column (PRIM_LIST.String)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List String Column (PRIM_LIST.String)
DoubleClick Fired when the user double clicks
Enter Fired when the Enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocus Fires when column receives focus
KeyPress Fired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocus Fires when column loses focus
PrompterActivate Fired when the prompter image is clicked
Form, Continue

Methods

Name Description
SizeToContents Set the column width to the widest content Inherited from List Column (PRIM_LIST.Column)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020