Click or drag to resize

MultiLineEdit Class

X#
Create a multiline edit control for displaying and entering information to a variable or field in a server. Multiline edit controls may be bound to a data server field of any type (character, date, logical, numeric, or memo).
Inheritance Hierarchy
Object
  VObject
    Control
      TextControl
        Edit
          MultiLineEdit
            RichEdit

Namespace:  VO
Assembly:  VOGUIClasses (in VOGUIClasses.dll) Version: 2.19
Syntax
 CLASS MultiLineEdit INHERIT Edit
Request Example View Source

The MultiLineEdit type exposes the following members.

Constructors
  NameDescription
Public methodMultiLineEdit
Construct a multiline edit control.
Top
Properties
  NameDescription
Public propertyBackground
The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
(Inherited from Control.)
Public propertyCaption
Caption text is not displayed for single-line or multiline edit controls. It can be used to store general text information.
(Inherited from Edit.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a control.
(Inherited from Control.)
Public propertyControlFont
The font used to draw the text in the control.
(Inherited from TextControl.)
Public propertyControlID
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.)
Public propertyCurrentText
A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING.
(Inherited from TextControl.)
Public propertyFieldSpec
The field specification connected to the control.
(Inherited from Control.)
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyLength
A numeric value representing the number of characters in the control.
(Inherited from TextControl.)
Public propertyLineCount
A numeric value representing the number of lines in a multiline edit control.
Public propertyMargins
A Dimension object specifying the left and right margins of the edit control.
(Inherited from Edit.)
Public propertyModified
A logical value indicating whether an editable control is in the process of being modified.
(Inherited from Edit.)
Public propertyName
A string representing the name of the control.
(Inherited from Control.)
Public propertyNameSym
A symbol representing the name of the control.
(Inherited from Control.)
Public propertyOrigin
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.)
Public propertyOwner
The owner window of a control.
(Inherited from Control.)
Public propertyOwnerAlignment
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.)
Public propertyReadOnly
A logical value specifying the read-only state of an edit control.
(Inherited from Edit.)
Public propertySelectedText
A string representing the text that is currently selected in this edit control.
(Inherited from Edit.)
Public propertySelection
The position of the cursor in the edit control.
(Inherited from Edit.)
Public propertyServer
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.)
Public propertySize
A dimension representing the size of a control.
(Inherited from Control.)
Public propertyStatus
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.)
Public propertyTextColor
The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.)
(Inherited from TextControl.)
Public propertyTextLimit
A numeric value representing the maximum number of characters this edit control can hold.
(Inherited from Edit.)
Public propertyTextValue
A string representing the value held in the control.
(Inherited from Edit.)
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
Public propertyUseHLForToolTip
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.)
Public propertyCode exampleValue
The value held in the control, in whatever data type the control holds.
(Inherited from Control.)
Public propertyValueChanged
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.)
Top
Methods
  NameDescription
Public methodActivate
Provide a method that is invoked when the control has focus and a window is activated.

(Inherited from Control.)
Public methodAsString
Return the contents of the control (or its identifying label).
(Inherited from Control.)
Public methodCanUndo
Determine if the Edit:Undo() method can be called for this edit control.
(Inherited from Edit.)
Public methodClear
Delete the current selection in this edit control.
(Inherited from Edit.)
Public methodCopy
Copy the current selection in this edit control to the clipboard.
(Inherited from Edit.)
Public methodCreate
Creates the underlying Win32 control
(Inherited from TextControl.)
Public methodCut
Delete the current selection in this edit control and copy it to the clipboard.
(Inherited from Edit.)
Public methodDeactivate
Provide a method that is invoked when the control has focus and a window is deactivated.

(Inherited from Control.)
Public methodDEFAULT
Call the default windows procedure for a control and set the EventReturnValue.
(Inherited from Control.)
Public methodDestroy
Provide a method to de-instantiate any TextControl.Destroy object.
(Inherited from TextControl.)
Public methodDisable
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.)
Public methodDisableTheme
Disable the WinXP theme for a control.
(Inherited from Control.)
Public methodDispatch
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers.

(Overrides Dispatch(Usual).)
Public methodEnable
Enable a control that was previously disabled.
(Inherited from Control.)
Public methodExpose
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting.

(Inherited from Control.)
Public methodFocusChange
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa).

(Inherited from Control.)
Public methodGetExStyle
Retrieve the Ex styles for the control.
(Inherited from Control.)
Public methodGetLine
Get a line of text—specified by position—in a multiline edit control.
Public methodGetLineLength
Get the length of a line of text—specified by position—in a multiline edit control.
Public methodGetStyle
Retrieve the styles for the control.
(Inherited from Control.)
Public methodHandle
Return the handle for a control.
(Inherited from Control.)
Public methodHasBorder
Check if a border has been set for the control
(Inherited from Control.)
Public methodHasStyle
Check if a style value has been set for the control
(Inherited from Control.)
Public methodHide
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.)
Public methodHorizontalScroll
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.

(Inherited from Control.)
Public methodIme
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.)
Public methodIsEnabled
Report if this control is currently enabled.
(Inherited from Control.)
Public methodIsExStyle
Check if a exstyle value has been set for the control
(Inherited from Control.)
Public methodIsReadOnly
Report if this control is currently readonly.
(Inherited from Control.)
Public methodIsStyle
Check if a style value has been set for the control
(Inherited from Control.)
Public methodIsVisible
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.)
Public methodKeyDown
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed.

(Inherited from Control.)
Public methodKeyUp
Provide a method that is invoked when the control has focus and a key on the keyboard is released.

(Inherited from Control.)
Public methodLineDown
Move the cursor from its current position in a multiline edit control down a single line.
Public methodLineUp
Move the cursor from its current position in a multiline edit control up a single line.
Public methodLinkDF
Connect a control to a data field in a data server.
(Inherited from Control.)
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.)
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.)
Public methodMouseButtonDoubleClick
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked.

(Inherited from Control.)
Public methodMouseButtonDown
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked.

(Inherited from Control.)
Public methodMouseButtonUp
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.)
Public methodMouseDrag
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.)
Public methodMouseMove
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.)
Public methodMove
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Inherited from Control.)
Public methodOverRide
This is a compatibility method that is no longer used or needed.
(Inherited from Control.)
Public methodPageDown
Move the cursor from its current position in a multiline edit control down a single page length.
Public methodPageUp
Move the cursor from its current position in a multiline edit control up a single page length.
Public methodPaste
Replace the current selection in this edit control with a string, if specified, or the contents of the clipboard.
(Inherited from Edit.)
Public methodPerformValidations
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.)
Public methodRegisterTimer
Register a timer method to be invoked for the control.
(Inherited from Control.)
Public methodRemoveEditBalloonTip
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodRePaint
Send an ExposeEvent to repaint the control
(Inherited from Control.)
Public methodResize
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.)
Public methodRestoreUpdate
Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
(Inherited from Control.)
Public methodScrollHorizontal
Scroll the text in a multiline edit control a specified number of characters to the right or left.
Public methodScrollVertical
Scroll the text in a multiline edit control a specified number of characters up or down.
Public methodSetCueBanner
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodSetExStyle
Set the exstyle for the control.
(Inherited from Control.)
Public methodSetFocus
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.)
Public methodSetParent
Change the parent handle for the control.
(Inherited from Control.)
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodShow
Display a control so it is visible.
(Inherited from Control.)
Public methodShowEditBalloonTip
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodSuspendUpdate
Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
(Inherited from Control.)
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.)
Public methodUndo
Undo the last modification to the text in this edit control.
(Inherited from Edit.)
Public methodValidateControl
This method validates if the control has been created and when not then it triggers the control creation
(Inherited from Control.)
Public methodVerticalScroll
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.)
Top
Fields
  NameDescription
Public fieldEventReturnValue (Inherited from Control.)
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
Some of the features provided by multiline edit controls include scrolling lines and pages and retrieving specified lines (in addition to the simple editing primitives inherited from the Edit class).
Examples
This example creates and initializes a multiline edit control:
X#
 1CLASS MyWindow INHERIT TopAppWindow
 2HIDDEN oMyMLE AS OBJECT
 3METHOD Init() CLASS MyWindow
 4SUPER:Init()
 5p := Point{10, 10}
 6d := Dimension{100, 100}
 7oMyMLE := MultiLineEdit{SELF,100,p,d}
 8SELF:Show()
 9oMyMLE:Show()
10oMyMLE:TextValue := "New York" + _CHR(10) + "Boston"
In Windows, multiline edit controls are equivalent to an edit control created with the ES_MULTILINE style. These are normally specified in the resource entity like this:
X#
1RESOURCE IDD_ABOUT DIALOG 20, 20, 160, 80
2STYLE WS_POPUP | WS_DLGFRAME
3BEGIN
4EDITTEXT    IDE_TEXT,10,10,90,45, ES_MULTILINE
5DEFPUSHBUTTON "OK"     IDB_OK,64,60,32,14, WS_GROUP
6END
See Also

Reference