List String Column (PRIM_LIST.String)

Column displaying numerical data

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

NameDescription
AutoSelectAutomatically select the text when the control receives focus
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)
CharacterCaseCharacterCase sets character case
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)
ColumnCaptionTypeType of caption to appear in the column header
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)
ColumnReadOnlySpecifies whether the column is input capable
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
DisplayAlignmentDisplayAlignment sets edit box alignment when not in focus
DisplayPositionPosition of the column relative to the other columns Inherited from List Column (PRIM_LIST.Column)
EditAlignmentEditAlignment sets the alignment of the text when in focus
EnabledEnable or disable the column contents Inherited from List Column (PRIM_LIST.Column)
FocusItemReference to the focus item in the column
MaxLengthMaxLength sets the maximum number of characters
NameName identifies the component Inherited from Object (PRIM_OBJT)
NumericEditStyleNumericEditStyle controls insert and overtype data entry styles for numbers
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentReference to the list containing the column Inherited from List Column (PRIM_LIST.Column)
PasswordCharCharacter to use to mask the data being entered
PrompterImageImage used to override the default file prompter image
ShowPrompterShow or hide the prompter
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)
SortOnClickSort the column when the column header is clicked
SortPositionPosition of the column in the sort sequence Inherited from List Column (PRIM_LIST.Column)
SourceName of the repository field used to define and store the data for this 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)
WordWrapWrap text on to the next line if there is insufficient space

Events

NameDescription
AutoCompletingFired as a value is being edited allowing for a replacement value to be returned
Value
ClickFired when the mouse is clicked on the control
ColumnClickFired when the column header is clicked Inherited from List String Column (PRIM_LIST.String)
Origin, Handled
ColumnDoubleClickFired when the column header is DoubleClicked Inherited from List String Column (PRIM_LIST.String)
Origin, Handled
ColumnMouseEnterFired when the mouse enters the bounds of the column Inherited from List String Column (PRIM_LIST.String)
ColumnMouseLeaveFired when the mouse leaves the bounds of the column Inherited from List String Column (PRIM_LIST.String)
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from List String Column (PRIM_LIST.String)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List String Column (PRIM_LIST.String)
DoubleClickFired when the user double clicks
EnterFired when the Enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
KeyPressFired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
PrompterActivateFired when the prompter image is clicked
Form, Continue

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