Multi-line Edit Box (PRIM_MEMO)
Multi-line entry field typically used for notes
Ancestors - Control (PRIM_CTRL)Object (PRIM_OBJT)
Details
A multi-line edit box or memo is used for text entry, allowing the enter large amounts of text. Memo was designed to work with fields of 256 bytes or less and therefore works like a list. As text is entered, it is divided in to individual entries based on the length of the data column. If more than one item is required, the line continuation character will be incremented. Pressing Enter to start a new line will create a new item.
Example
This example shows how the contents of the memo are parsed.
Function Options(*DIRECT)
Begin_Com Role(*EXTENDS #PRIM_FORM) Clientwidth(897) Clientheight(404) Componentversion(2) Top(227) Left(222) Layoutmanager(#TableLayout1)
Define_Com Class(#PRIM_TBLO) Name(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Column) Name(#Column1) Displayposition(1) Parent(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Column) Name(#Column2) Displayposition(2) Parent(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Row) Name(#Row1) Displayposition(1) Parent(#TableLayout1) Height(1.83)
Define_Com Class(#PRIM_TBLO.Item) Name(#Memo1Item1) Column(#Column1) Manage(#Memo1) Parent(#TableLayout1) Row(#Row1)
Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutItem1) Column(#Column2) Manage(#ListView1) Parent(#TableLayout1) Row(#Row1)
Define_Com Class(#PRIM_MEMO) Name(#Memo1) Componentversion(1) Currentline(1) Displayposition(1) Left(0) Parent(#COM_OWNER) Showselectionhilight(False) Tabposition(1) Top(0) Height(404) Width(449) Maximumlinelength(9999999) Addentrymode(MultiplePerLine) Wordwrap(True)
Define_Com Class(#PRIM_MECL) Name(#MECL1) Columnrole(Data) Displayposition(1) Parent(#Memo1) Source(#xDemoCaption)
Define_Com Class(#PRIM_MECL) Name(#MECL2) Columnrole(LineNumber) Displayposition(2) Parent(#Memo1) Source(#xDemoDecimal)
Define_Com Class(#PRIM_MECL) Name(#MECL3) Columnrole(LineContinuation) Displayposition(3) Parent(#Memo1) Source(#xDemoNumber)
Define_Com Class(#PRIM_LTVW) Name(#ListView1) Columnbuttonheight(19) Componentversion(2) Displayposition(2) Fullrowselect(True) Height(404) Keyboardpositioning(SortColumn) Left(449) Parent(#COM_OWNER) Showsortarrow(True) Tabposition(2) Top(0) Width(448)
Define_Com Class(#PRIM_LVCL) Name(#LVCL1) Displayposition(1) Parent(#ListView1) Source(#xDemoCaption) Width(63) Widthtype(Remainder)
Define_Com Class(#PRIM_LVCL) Name(#LVCL2) Displayposition(2) Parent(#ListView1) Source(#xDemoDecimal) Caption('Line Number') Captiontype(Caption)
Define_Com Class(#PRIM_LVCL) Name(#LVCL3) Displayposition(3) Parent(#ListView1) Source(#xDemoNumber) Caption('Continuation') Captiontype(Caption)
Evtroutine Handling(#Memo1.Enter)
Clr_List Named(#ListView1)
Selectlist Named(#Memo1)
Add_Entry To_List(#ListView1)
Endselect
Endroutine
End_Com
Properties
| Name | Description |
|---|---|
| AddEntryMode | AddEntryMode determines how data is added to the edit box |
| BusyUpdates | BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) |
| BusyUpdatesOfParent | BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) |
| CanFocus | CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) |
| CharacterPosition | CharacterPosition is the position of the cursor |
| Columns | Columns gives you access to the properties of the columns |
| 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) |
| ComponentVersion | Variant of the control being used |
| CurrentLine | CurrentLine is the line where the cursor is |
| Cursor | Cursor sets the cursor image Inherited from Control (PRIM_CTRL) |
| DisableNoScroll | DisableNoScroll controls whether scroll bars are displayed. |
| DisplayPosition | DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) |
| DragStyle | DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) |
| EnableCut | EnableCut controls whether text can be cut |
| Enabled | Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
| EnablePaste | EnablePaste controls whether text can be pasted |
| Entries | The number of entries in the underlying data list |
| FixedPosition | Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) |
| Focus | Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) |
| FocusedStyle | Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FocusedStyles | Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| Handle | Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) |
| HasSelection | True if some of the editable text is selected |
| Height | The height of the control in pixels Inherited from Control (PRIM_CTRL) |
| Hint | Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) |
| HintPopup | HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) |
| HintShow | Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) |
| HintShowOfParent | Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) |
| HintTitle | HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) |
| HorizontalScroll | Show the horizontal scroll bar |
| IsAnimating | IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) |
| IsRealized | True if the control is currently realized Inherited from Control (PRIM_CTRL) |
| Items | Collection of items in the component |
| Left | Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) |
| LineCount | LineCount holds the number of lines in the edit box |
| MarginLeft | MarginLeft controls the width of the left margin |
| MaximumLineLength | MaximumLineLength limits the number of characters per line |
| MaximumLines | MaximumLines sets the maximum number of lines |
| MemoDialogs | Defines which inbuilt memo features will be available |
| Modified | Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) |
| MouseOver | MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) |
| MouseOverStyle | MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| MouseOverStyles | MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| OnOutput | OnOutput determines the output format of the text |
| Opacity | Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) |
| OutputText | OutputText is all the text in the multi-line edit box |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL) |
| Popup | Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) |
| PopupMenu | Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) |
| ReadOnly | ReadOnly controls whether a component can be used for input |
| Rotation | Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) |
| RotationOriginLeft | RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| RotationOriginTop | RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| ScaleHeight | ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScaleOriginLeft | ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleOriginTop | ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleWidth | ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScreenLeft | ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) |
| ScreenTop | ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) |
| ScrollLeft | Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ScrollTop | Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ShowLineNumbers | ShowLineNumbers controls whether line numbers are shown |
| ShowSelectionHilight | Highlight selected items when the control does not have focus |
| SkewLeft | SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) |
| SkewOriginLeft | SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewOriginTop | SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewTop | SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) |
| SplitStyle | SplitStyle enables independent pane scrolling |
| Style | Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) |
| Styles | Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) |
| TabPosition | TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) |
| TabStop | Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) |
| ThemeDrawStyle | Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL) |
| Top | Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) |
| TouchMove | Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) |
| TouchRotate | Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) |
| TouchScale | Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) |
| TouchScroll | Specifies how the control will respond to touch input for scrolling |
| TouchSize | Determines whether a control can be resized Inherited from Control (PRIM_CTRL) |
| VerticalScroll | Show the vertical scroll bar |
| Visible | Show or hide the control Inherited from Control (PRIM_CTRL) |
| VisualStyle | VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) |
| VisualStyleOfParent | Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) |
| Width | Width of the component in pixels Inherited from Control (PRIM_CTRL) |
| WordWrap | Wrap text on to the next line if there is insufficient space |
Events
| Name | Description |
|---|---|
| AnimationEnded | Fired when an animation is ended Inherited from Multi-line Edit Box (PRIM_MEMO) Cancelled |
| Changed | Changed is a change in the component |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Multi-line Edit Box (PRIM_MEMO) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Multi-line Edit Box (PRIM_MEMO) |
| DragDrop | Fired on mouse up to signify the end of a drag process Inherited from Multi-line Edit Box (PRIM_MEMO) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult |
| DragOver | Fired during the drag and drop process when the cursor moves over the control Inherited from Multi-line Edit Box (PRIM_MEMO) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled |
| EndDrag | Fired when the drag and drop process has completed Inherited from Multi-line Edit Box (PRIM_MEMO) Source, Payload, DragResult, AggregatedSource, Origin, Handled |
| Enter | Fired when the Enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled |
| GotFocus | Fired when the control receives the focus |
| Initialize | Fired after a component has been realized for the first time Inherited from Multi-line Edit Box (PRIM_MEMO) |
| KeyPress | Fired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled |
| LineChanged | LineChanged is triggered when the cursor is moved to another line |
| LostFocus | LostFocus happens when a component is no longer active |
| MouseEnter | The mouse has entered the bounds of the control Inherited from Multi-line Edit Box (PRIM_MEMO) |
| MouseHover | The mouse has hovered over the control Inherited from Multi-line Edit Box (PRIM_MEMO) Origin, Handled |
| MouseLeave | The mouse has left the bounds of the control Inherited from Multi-line Edit Box (PRIM_MEMO) |
| PositionChanged | Fired when the cursor is moved |
| StartDrag | Fired when the user starts a drag and drop process Inherited from Multi-line Edit Box (PRIM_MEMO) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled |
| TouchChange | Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Multi-line Edit Box (PRIM_MEMO) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue |
| TouchEnd | Fired when the user stops touching the screen Inherited from Multi-line Edit Box (PRIM_MEMO) |
| TouchStart | Fired when the user first makes physical contact with the screen Inherited from Multi-line Edit Box (PRIM_MEMO) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
| Name | Description |
|---|---|
| Copy | Copy copies text to the clipboard |
| Cut | Cut deletes text and puts it on the clipboard |
| FadeIn | Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay |
| FadeOut | Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible |
| Find | Show the memo find dialog |
| MoveFrom | Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| MoveTo | Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| Paste | Paste pastes the contents of the clipboard |
| Print method sends the text to a printer | |
| Realize | Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| Redo | Redo reapplies an action that was undone |
| Replace | Replace finds and replaces a string |
| Scale | Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay |
| SelectAll | SelectAll selects all text |
| SelectMultiLineText | SelectMultiLineText selects text over multiple lines
StartLineNumber, StartPosition, EndLineNumber, EndPosition |
| SetFocus | Sets the control to be the focus control Inherited from Control (PRIM_CTRL) |
| ShowMessages | LANSA Internal Use Inherited from Control (PRIM_CTRL) |
| SizeTo | Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay |
| Undo | Undo method reverses the last action |
| Unrealize | Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| UpdateDisplay | UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |
See also
LANSA Version 15, April 2020