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

NameDescription
AddEntryModeAddEntryMode determines how data is added to the edit box
BusyUpdatesBusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParentBusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocusCanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CharacterPositionCharacterPosition is the position of the cursor
ColumnsColumns gives you access to the properties of the columns
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)
ComponentVersionVariant of the control being used
CurrentLineCurrentLine is the line where the cursor is
CursorCursor sets the cursor image Inherited from Control (PRIM_CTRL)
DisableNoScrollDisableNoScroll controls whether scroll bars are displayed.
DisplayPositionDisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyleDragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
EnableCutEnableCut controls whether text can be cut
EnabledEnable activates/deactivates the component Inherited from Control (PRIM_CTRL)
EnablePasteEnablePaste controls whether text can be pasted
EntriesThe number of entries in the underlying data list
FixedPositionFix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
FocusFocus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyleReference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStylesCollection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
HandleReturns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasSelectionTrue if some of the editable text is selected
HeightThe height of the control in pixels Inherited from Control (PRIM_CTRL)
HintCaption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopupHintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShowEnabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParentDelegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitleHintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
HorizontalScrollShow the horizontal scroll bar
IsAnimatingIsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealizedTrue if the control is currently realized Inherited from Control (PRIM_CTRL)
ItemsCollection of items in the component
LeftPosition of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
LineCountLineCount holds the number of lines in the edit box
MarginLeftMarginLeft controls the width of the left margin
MaximumLineLengthMaximumLineLength limits the number of characters per line
MaximumLinesMaximumLines sets the maximum number of lines
MemoDialogsDefines which inbuilt memo features will be available
ModifiedModified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOverMouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyleMouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStylesMouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
NameName identifies the component Inherited from Object (PRIM_OBJT)
OnOutputOnOutput determines the output format of the text
OpacityOpacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
OutputTextOutputText is all the text in the multi-line edit box
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentReference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
PopupPopup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenuReference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
ReadOnlyReadOnly controls whether a component can be used for input
RotationRotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeftRotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTopRotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeightScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeftScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTopScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidthScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeftScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTopScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeftLeft position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTopTop position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ShowLineNumbersShowLineNumbers controls whether line numbers are shown
ShowSelectionHilightHighlight selected items when the control does not have focus
SkewLeftSkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeftSkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTopSkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTopSkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
SplitStyleSplitStyle enables independent pane scrolling
StyleStyle defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
StylesCollection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPositionTabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStopSet to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeDrawStyleName of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
TopPosition of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMoveDetermines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotateDetermines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScaleDetermines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchScrollSpecifies how the control will respond to touch input for scrolling
TouchSizeDetermines whether a control can be resized Inherited from Control (PRIM_CTRL)
VerticalScrollShow the vertical scroll bar
VisibleShow or hide the control Inherited from Control (PRIM_CTRL)
VisualStyleVisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParentAdopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
WidthWidth of the component in pixels Inherited from Control (PRIM_CTRL)
WordWrapWrap text on to the next line if there is insufficient space

Events

NameDescription
AnimationEndedFired when an animation is ended Inherited from Multi-line Edit Box (PRIM_MEMO)
Cancelled
ChangedChanged is a change in the component
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Multi-line Edit Box (PRIM_MEMO)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Multi-line Edit Box (PRIM_MEMO)
DragDropFired 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
DragOverFired 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
EndDragFired when the drag and drop process has completed Inherited from Multi-line Edit Box (PRIM_MEMO)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
EnterFired when the Enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocusFired when the control receives the focus
InitializeFired after a component has been realized for the first time Inherited from Multi-line Edit Box (PRIM_MEMO)
KeyPressFired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LineChangedLineChanged is triggered when the cursor is moved to another line
LostFocusLostFocus happens when a component is no longer active
MouseEnterThe mouse has entered the bounds of the control Inherited from Multi-line Edit Box (PRIM_MEMO)
MouseHoverThe mouse has hovered over the control Inherited from Multi-line Edit Box (PRIM_MEMO)
Origin, Handled
MouseLeaveThe mouse has left the bounds of the control Inherited from Multi-line Edit Box (PRIM_MEMO)
PositionChangedFired when the cursor is moved
StartDragFired when the user starts a drag and drop process Inherited from Multi-line Edit Box (PRIM_MEMO)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChangeFired 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
TouchEndFired when the user stops touching the screen Inherited from Multi-line Edit Box (PRIM_MEMO)
TouchStartFired when the user first makes physical contact with the screen Inherited from Multi-line Edit Box (PRIM_MEMO)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

NameDescription
CopyCopy copies text to the clipboard
CutCut deletes text and puts it on the clipboard
FadeInAnimate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOutAnimate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
FindShow the memo find dialog
MoveFromMove a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveToAnimate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
PastePaste pastes the contents of the clipboard
PrintPrint method sends the text to a printer
RealizeCreates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
RedoRedo reapplies an action that was undone
ReplaceReplace finds and replaces a string
ScaleAnimate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SelectAllSelectAll selects all text
SelectMultiLineTextSelectMultiLineText selects text over multiple lines
StartLineNumber, StartPosition, EndLineNumber, EndPosition
SetFocusSets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowMessagesLANSA Internal Use Inherited from Control (PRIM_CTRL)
UndoUndo method reverses the last action
UnrealizeDestroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplayUpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2