@... EDITBOX
DEFINE EDITBOX 
Creates an EditBox control.
  

An EditBox control is a rectangular control window typically used in a dialog box to permit the user to enter and edit text by typing on the keyboard.

SYNTAX

Standard Window:

@ <nRow> ,<nCol> EDITBOX <ControlName>
[ ID <nId> ]
[ OF | PARENT | DIALOG <ParentWindowName> ]
[ WIDTH <nWidth> ]
[ HEIGHT <nHeight> ]
[ FIELD <FieldName> ]
[ VALUE <cValue> ]
[ READONLY ]
[ FONT <cFontName> SIZE <nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <cToolTipText> ]
[ BACKCOLOR <anBackColor> ] // * or <anBackColor,anReadOnlyBackColor>
[ FONTCOLOR <anFontColor> ] // * or <anFontColor,anReadOnlyFontColor>
[ MAXLENGTH <nInputLength> ]
[ ON GOTFOCUS <OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <OnChangeProcedure> | <bBlock> ]
[ ON LOSTFOCUS <OnLostFocusProcedure> | <bBlock> ]
[ HELPID <nHelpId> ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ NOVSCROLL ]
[ NOHSCROLL ]
[ ON INIT <bInit> ]

Dialog Window:

REDEFINE EDITBOX <ControlName>
ID <nId>
[ OF | PARENT | DIALOG <ParentWindowName> ]
[ FIELD <FieldName> ]
[ VALUE <cValue> ]
[ READONLY ]
[ FONT <cFontName> SIZE <nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <cToolTipText> ]
[ BACKCOLOR <anBackColor> ] // * or <anBackColor,anReadOnlyBackColor>
[ FONTCOLOR <anFontColor> ] // * or <anFontColor,anReadOnlyFontColor>
[ MAXLENGTH <nInputLength> ]
[ ON GOTFOCUS <OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <OnChangeProcedure> | <bBlock> ]
[ ON LOSTFOCUS <OnLostFocusProcedure> | <bBlock> ]
[ HELPID <nHelpId> ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ NOVSCROLL ]
[ NOHSCROLL ]
[ ON INIT <bInit> ]

SPLITBOX VERSION

EDITBOX <ControlName>
[ OF | PARENT <ParentWindowName> ]
[ WIDTH <nWidth> ]
[ HEIGHT <nHeight> ]
[ FIELD <FieldName> ]
[ VALUE <cValue> ]
[ READONLY ]
[ FONT <cFontName> SIZE <nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <cToolTipText> ]
[ BACKCOLOR <anBackColor> ] // * or <anBackColor,anReadOnlyBackColor>
[ FONTCOLOR <anFontColor> ] // * or <anFontColor,anReadOnlyFontColor>
[ MAXLENGTH <nInputLength> ]
[ ON GOTFOCUS <OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <OnChangeProcedure> | <bBlock> ]
[ ON LOSTFOCUS <OnLostFocusProcedure> | <bBlock> ]
[ HELPID <nHelpId> ]
[ BREAK ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ NOVSCROLL ]
[ NOHSCROLL ]
[ ON INIT <bInit> ]

Alternate Syntax:

DEFINE EDITBOX <ControlName>
[ ID <nId> ]
[ PARENT <ParentWindowName> ]
COL <nCol>
ROW <nRow>
[ WIDTH <nWidth> ]
[ HEIGHT <nHeight> ]
[ FIELD <FieldName> ]
[ VALUE <cValue> ]
[ READONLY < .T. | .F.> ]
[ FONTNAME <cFontName> ]
[ FONTSIZE <nFontSize> ]
[ FONTBOLD < .T. | .F.> ]
[ FONTITALIC < .T. | .F.> ]
[ FONTUNDERLINE < .T. | .F.> ]
[ FONTSTRIKEOUT < .T. | .F.> ]
[ TOOLTIP <cToolTipText> ]
[ BACKCOLOR <anBackColor> ] // * or <anBackColor,anReadOnlyBackColor>
[ FONTCOLOR <anFontColor> ] // * or <anFontColor,anReadOnlyFontColor>
[ MAXLENGTH <nInputLength> ]
[ ONGOTFOCUS <OnGotFocusProcedure> | <bBlock> ]
[ ONCHANGE <OnChangeProcedure> | <bBlock> ]
[ ONLOSTFOCUS <OnLostFocusProcedure> | <bBlock> ]
[ HELPID <nHelpId> ]
[ INVISIBLE < .T. | .F.> ]
[ NOTABSTOP < .T. | .F.> ]
[ NOVSCROLLBAR < .T. | .F.> ]
[ NOHSCROLLBAR < .T. | .F.> ]
[ ONINIT <bInit> ]

END EDITBOX

Note: Since version HMG 1.1 Experimental 12a FontColor and BackColor property can be defined as RGB array or array of RGBArrays for Enable and ReadOnly stage ReadOnly stage preserve defined FontColor and BackColor


DESCRIPTION:
nRow, nCol
Position in the area of ??the window in pixels.
nWidth, nHeight
The desired size of the ComboBox Control in pixels.
nId
The ID identifier this Control in Dialog Window
ControlName
A reference to the ComboBox Control
ParentWindowName
A reference to the Parent Window.
nHelpId
The help topic identifier for this Control
FieldName
Specifies the Field Name to use as Data Source
cValue
Specifies the startup value of the EditBox control
FontName
Specifies the Font Name
FontSize
Specifies the Font Size
cToolTipText
Specifies the Text for the ToolTip
anBackColor
Specifies the Background Color
anFontColor
Specifies the Font Color
anReadOnlyBackColor
Specifies the Background Color when control is READONLY
anReadOnlyFontColor
Specifies the Font Color when control is READONLY
nInputLength
Specifies the number of characters that can be entered
OnGotFocusProcedure
Procedure to execute when GotFocus
OnChangeProcedure
Procedure to execute when Change
OnLostFocusProcedure
Procedure to execute when LostFocus
 
 
READONLY
Specifies that the EditBox is not modifiable thus READONLY
INVISIBLE
The visibility property specifies whether or not a control is visible
NOTABSTOP
Stop the control to receive focus and participate in the tabbing sequence
NOVSCROLL
Specified that we don't want Vertical Scrolling
NOHSCROLL
Specified that we don't want Horizontal Scrolling
NOVSCROLLBAR
Specified that we don't want Vertical Scroll Bar
NOHSCROLLBAR
Specified that we don't want Horizontal Scroll Bar


PROPERTIES:

·   Value
Set / Gets EditBox value.
·   Enabled
Set / Gets enabled state of a EditBox control
·   Visible
Set / Gets visible a EditBox control.
·   Row
Set / Gets row position of a EditBox control.
·   Col
Set / Gets column position of a EditBox control.
·   Width
Set / Gets width of a EditBox control.
·   Height
Set / Gets height of a EditBox control.
·   FontName
Set / Gets EditBox control's font name.
·   FontSize
Set / Gets EditBox control's font size.
·   FontBold
Set / Gets EditBox control's font bold property
·   FontItali
Set / Gets EditBox control's font italic property
Set / Gets EditBox control's font underline property
Set / Gets EditBox control's font strikeout property
·   FontColor
Set / Gets the foreground color for text within the EditBox
·   BackColor
Set / Gets the background color for text within the EditBox
·   ToolTip
Set / Gets EditBox control's tooltip text.
·   CaretPos
Set / Gets the caret position of a EditBox control.
Set / Gets user property 'CaseConvert' for EditBox control
·   Cargo
Set / Gets user property 'Cargo' for EditBox control
·   Name (R)
Retrieves the name of a EditBox control.
·   Parent(D)
Set the name as character identifier of the parent window.
·   HelpId (D)
Set the numeric help topic identifier of the control.
·   Field(D)
Set the Field data of active database.
·   ReadOnly
Set / Gets EditBox control's readonly property
·   MaxLength(D)
Set the length of editorial field in signs.
·   NoTabStop(D)
Sets whether an element behavior can't receive focus and participate in the tabbing sequence
·   VScrollBar(D)
Automatically scrolls text up one page when the user presses the ENTER key on the last line.
·   HScrollBar(D)
Automatically scrolls text to the right by 10 characters when the user types a character at the end of the line.
·   Break(D)
Control passes to the statement that follows the terminated statement.

D: Available at control definition only
R: Read-Only

EVENTS:

·   OnGotFocus
Action to be performed when getting the focus
·   OnChange
Action to be performed when generic changing of the control
Action to be performed when losing the focus.

METHODS:

·   Show
Shows a EditBox control
·   Hide
Hides a EditBox control
·   Redraw
Redraw a Control
·   SetFocus
Gives the focus to a EditBox control
·   Release
Releases a EditBox control from memory
·   Refresh
Repaint a Control
·   Save
Save data for Control EditBox
·   SaveAs
Save a EditBox control as BitMap file.

EXAMPLE:

See demos in :
\Samples\Basic\Edit
\Samples\Basic\ReadOnlyEdit
\Samples\Basic\MAINDEMO_(SYNTAX_I) to _(SYNTAX_IV)

and sample in Chapter Getting Large Text (The EditBox Control)