List Edit Field Current Item (PRIM_MD.ListEditCurrentItem)

Provides access to the edit field of the current list item

Ancestors - List CurrentItem (PRIM_MD.ListCurrentItem)Object (PRIM_OBJT)

Details

Prim_MD.ListEdit is a control List that is visualized as a Edit.
 
Each control type has a corresponding control class that provides access to the control instance.
The Edit for each item can be modified independently using the current item for the control in the same way that other visual LANSA lists allow the current item for the list to be used.
 
A Edit control is created whenever a Edit is dragged and dropped from the controls view.

Example

This example shows a single control list updating each button after it's added to the list.
 
When a Edit is changed the current item for the control is accessed and the caption shows which button was clicked.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(456) Width(864) Layoutmanager(#Layout1)
 
    Define_Com Class(#PRIM_TBLO) Name(#Layout1)
    Define_Com Class(#PRIM_TBLO.Row) Name(#Layout1Row1) Displayposition(1) Parent(#Layout1)
    Define_Com Class(#PRIM_TBLO.Column) Name(#Layout1Column1) Displayposition(1) Parent(#Layout1)
    Define_Com Class(#PRIM_TBLO.Item) Name(#Layout1Item1) Column(#Layout1Column1) Manage(#List) Parent(#Layout1) Row(#Layout1Row1)
    Define_Com Class(#PRIM_TBLO) Name(#Layout2)
    Define_Com Class(#PRIM_TBLO.Row) Name(#Layout2Row1) Displayposition(1) Parent(#Layout2)
    Define_Com Class(#PRIM_TBLO.Column) Name(#Layout2Column1) Displayposition(1) Parent(#Layout2)
    Define_Com Class(#PRIM_TBLO.Item) Name(#Layout2Item1) Column(#Layout2Column1) Parent(#Layout2) Row(#Layout2Row1)
 
    Define_Com Class(#PRIM_MD.List) Name(#List) Displayposition(1) Left(0) Parent(#COM_OWNER) Tabposition(1) Top(0) Height(456) Width(864) Layoutmanager(#Layout2)
    Define_Com Class(#PRIM_MD.ListEdit) Name(#ListEdit) Parent(#List) Displayposition(1) Tabposition(1) Left(0) Top(0) Width(864)
 
        Evtroutine Handling(#Com_owner.CreateInstance)
 
            Begin_Loop Using(#xDemoNumber) To(10)
 
                Add_Entry To_List(#List)
 
                #ListEdit.CurrentItem.Caption := ("Edit &1").Substitute( #xDemoNumber.AsString )
 
            End_Loop
 
        Endroutine
 
        Evtroutine Handling(#ListEdit.Changed)
 
            #ListEdit.CurrentItem.Caption := "Changed"
 
        Endroutine
 
End_Com

Properties

Name Description
Appearance Format of the control Inherited from Field (PRIM_MD.Input)
Caption Text to be shown within the control
CaptionColor Color of the caption
CaptionPosition Sets the position of Caption
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)
DisplayAlignment DisplayAlignment sets edit box alignment when not in focus
EditAlignment EditAlignment sets the alignment of the text when in focus
Enabled Enable or disable the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HasSelection True if some of the editable text is selected
Height The height of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HelperColor Color of the helper
HelperPosition Position where the helper text will be displayed
HelperText Text to show in the Helper area of the item
Hint Hint to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintTitle Hint title to be shown for the current item of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
Icon Image displayed within the item
IconColor Color to be applied to the icon
IconFileName FileName is the name of image file
IconHeight Height of the icon in pixels
IconImage Material design image to show on the control
IconImageSizing Specifies the sizing behaviour of the IconImage
IconOpacity Percentage opacity of the icon
Left Position of the list item relative to the left boundary of its list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MaxLength MaxLength sets the maximum number of characters
MouseOverStyle Style applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MouseOverStyles Collection of styles to be applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MultiLine Allow text to wrap to a new line
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)
PasswordChar Character to use to mask the data being entered
Placeholder Text to be shown when the edit has no value
PlaceholderColor Color of the placeholder text
Popup Popup to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
PromptIcon Image displayed within the input
PromptIconColor Color to be applied to the icon
PromptIconFileName FileName is the name of image file
PromptIconHeight Height of the icon in pixels
PromptIconHint Hint to be displayed
PromptIconImage Material design image to show on the control
PromptIconImageSizing Specifies the sizing behaviour of the IconImage
PromptIconOpacity Percentage opacity of the icon
PromptOnly Only allow input via the prompter
ReadOnly ReadOnly controls whether a component can be used for input
SelectionEnd Position in the value that selection ends
SelectionStart Position in the value that selection starts
SpellCheck Use browser spell checking features
Style Style to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
Styles Collection of styles to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the icon Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
Top Position of the list item relative to the top boundary of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
Value Value of the data class
Visible Show or hide the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
Width Width of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020