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

NameDescription
AppearanceFormat of the control Inherited from Field (PRIM_MD.Input)
CaptionText to be shown within the control
CaptionPositionSets the position of Caption
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)
DisplayAlignmentDisplayAlignment sets edit box alignment when not in focus
EditAlignmentEditAlignment sets the alignment of the text when in focus
EnabledEnable or disable the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HasSelectionTrue if some of the editable text is selected
HeightThe height of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HelperPositionPosition where the helper text will be displayed
HelperTextText to show in the Helper area of the item
HintHint to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
HintTitleHint title to be shown for the current item of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
IconImage displayed within the item
IconColorColor to be applied to the icon
IconFileNameFileName is the name of image file
IconHeightHeight of the icon in pixels
IconImageMaterial design image to show on the control
IconImageSizingSpecifies the sizing behaviour of the IconImage
IconOpacityPercentage opacity of the icon
LeftPosition of the list item relative to the left boundary of its list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MaxLengthMaxLength sets the maximum number of characters
MouseOverStyleStyle applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MouseOverStylesCollection of styles to be applied to the item when mouse over Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
MultiLineAllow text to wrap to a new line
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe 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)
PasswordCharCharacter to use to mask the data being entered
PlaceholderText to be shown when the edit has no value
PlaceholderColorColor of the placeholder text
PopupPopup to be shown for the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
PromptIconImage displayed within the input
PromptIconColorColor to be applied to the icon
PromptIconFileNameFileName is the name of image file
PromptIconHeightHeight of the icon in pixels
PromptIconImageMaterial design image to show on the control
PromptIconImageSizingSpecifies the sizing behaviour of the IconImage
PromptIconOpacityPercentage opacity of the icon
PromptOnlyOnly allow input via the prompter
ReadOnlyReadOnly controls whether a component can be used for input
SelectionEndPosition in the value that selection ends
SelectionStartPosition in the value that selection starts
SpellCheckUse browser spell checking features
StyleStyle to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
StylesCollection of styles to be applied to the current item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
ThemeDrawStyleName of the Theme DrawStyle to be applied to the icon Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
TopPosition of the list item relative to the top boundary of the list Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
ValueValue of the data class
VisibleShow or hide the list item Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
WidthWidth of the list item in pixels Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)

Events

NameDescription
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from List CurrentItem (PRIM_MD.ListCurrentItem)
DestroyInstanceDestroyInstance 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

V14SP2 April 2018