@...RICHEDITBOX
DEFINE RICHEDITBOX 
Create a RichEditBox control
  

Creates a RichEditBox control.

SYNTAX

Standard Window:

@ <nRow>,<nCol> RICHEDITBOX <ControlName>
[ OF | PARENT> <
ParentWindowName> ]
[ WIDTH <
nWidth> ]
[ HEIGHT <
nHeight> ]
[ FILE <
cFileName> ]
[ VALUE <
cValue> ]
[ READONLY ]
[ FONT <
cFontName> ]
[ SIZE <
nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <
cToolTipText> ]
[ BACKCOLOR <
anBackColor> ]
[ FONTCOLOR <
anFontColor> ]
[ MAXLENGTH <
nMaxLength> ]
[ ON GOTFOCUS <
OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <
OnChangeProcedure> | <bBlock> ]
[ ON SELECT <
OnSelectProcedure> | <bBlock> ]
[ ON LOSTFOCUS <
OnLostFocusProcedure> | <bBlock> ]
[ ON VSCROLL <
OnVScrollProcedure> | <bBlock> ]
[ HELPID <
nHelpId> ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ PLAINTEXT ]
[ NOHSCROLL ]
[ NOVSCROLL ]

FIELD VERSION

@ <nRow>,<nCol> RICHEDITBOX <ControlName>
[ OF | PARENT> <
ParentWindowName> ]
[ WIDTH <
nWidth> ]
[ HEIGHT <
nHeight> ]
FIELD <
cFileName>
[ VALUE <
cValue> ]
[ READONLY ]
[ FONT <
cFontName> ]
[ SIZE <
nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <
cToolTipText> ]
[ BACKCOLOR <
anBackColor> ]
[ FONTCOLOR <
anFontColor> ]
[ MAXLENGTH <
nMaxLength> ]
[ ON GOTFOCUS <
OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <
OnChangeProcedure> | <bBlock> ]
[ ON SELECT <
OnSelectProcedure> | <bBlock> ]
[ ON LOSTFOCUS <
OnLostFocusProcedure> | <bBlock> ]
[ ON VSCROLL <
OnVScrollProcedure> | <bBlock> ]
[ HELPID <
nHelpId> ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ PLAINTEXT]
[ NOHSCROLL]
[ NOVSCROLL]

SPLITBOX VERSION

RICHEDITBOX <ControlName>
[ OF | PARENT> <
ParentWindowName> ]
[ WIDTH <
nWidth> ]
[ HEIGHT <
nHeight> ]
[ FILE <
cFileName> ]
[ VALUE <
cValue> ]
[ READONLY ]
[ FONT <
cFontName> ]
[ SIZE <
nFontSize> ]
[ BOLD ] [ ITALIC ] [ UNDERLINE ] [ STRIKEOUT ]
[ TOOLTIP <
cToolTipText> ]
[ BACKCOLOR <
anBackColor> ]
[ FONTCOLOR <
anFontColor> ]
[ MAXLENGTH <
nMaxLength> ]
[ ON GOTFOCUS <
OnGotFocusProcedure> | <bBlock> ]
[ ON CHANGE <
OnChangeProcedure> | <bBlock> ]
[ ON SELECT <
OnSelectProcedure> | <bBlock> ]
[ ON LOSTFOCUS <
OnLostFocusProcedure> | <bBlock> ]
[ ON VSCROLL <
OnVScrollProcedure> | <bBlock> ]
[ HELPID <
nHelpId> ]
[ BREAK ]
[ INVISIBLE ]
[ NOTABSTOP ]
[ PLAINTEXT]
[ NOHSCROLL]
[ NOVSCROLL]

Alternate Syntax:

DEFINE RICHEDITBOX <ControlName>

[ ID <nId> ]
[ PARENT <
ParentWindowName> ]
COL <
nCol>
ROW <
nRow>
[ WIDTH <
nWidth> ]
[ HEIGHT <
nHeight> ]
[ FILE <
cFileName> ]
[ VALUE <
cValue> ]
[ READONLY ]
[ FONTNAME <
cFontname>
[ FONTSIZE <
nFontsize> ]
[ FONTBOLD < .T. | .F.> ]
[ FONTITALIC < .T. | .F.> ]
[ FONTUNDERLINE < .T. | .F.> ]
[ FONTSTRIKEOUT < .T. | .F.> ]
[ TOOLTIP <
cToolTip> ]
[ BACKCOLOR <
aBackColor> ]
[ FONTCOLOR <
aFontColor> ]
[ MAXLENGTH <
nMaxLength> ]
[ ONGOTFOCUS <
OnGotFocusProcedure> | <bBlock> ]
[ ONCHANGE <
OnChangeProcedure> | <bBlock> ]
[ ONSELECT <
OnSelectProceduree> | <bBlock> ]
[ ONLOSTFOCUS <
OnLostFocusProcedure> | <bBlock> ]
[ ONVSCROLL <
OnVScrollProcedure> | <bBlock> ]
[ HELPID <
nHelpId> ]
[ INVISIBLE < .T. | .F.> ]
[ NOTABSTOP < .T. | .F.> ]
[ PLAINTEXT < .T. | .F.> ]
[ NOHSCROLLBAR < .T. | .F.> ]
[ NOVSCROLLBAR< .T. | .F.> ]

END RICHEDITBOX


DESCRIPTION:
nRow, nCol
Position in the area of ??the window in pixels.
nWidth, nHeight
The desired size of the RichEditBox Control in pixels.
nId
The ID identifier this Control in Dialog Window
ControlName
A reference to the RIchEditBox Control
ParentWindowName
A reference to the Parent Window.
nHelpID
The help topic identifier for this Control
cFileName
Specifies a file name for the RichEditBox control
cValue
Specifies the starting value for the RichEditBox control
cFontName
Specifies the Font Name
cFontSize
Specifies the Font Size
cToolTipText
Specifies the Text for the ToolTip
anBackColor
Specifies the Background Color
anFontColor
Specifies the Font Color
nMaxLength
Specifies the Max Length for the ?
OnGotFocusProcedure
An action to be performed when control Got Focused
OnChangeProcedure
An action to be performed when control value changes
OnLostFocusProcedure
An action to be performed when control Lost Focused
OnVScrollProcedure
An aciton to be performed when using the vertical scroll
 
 
READONLY
Specifies that we want the control in readonly mode
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
PLAINTEXT
?
NOVSCROLL | NOVSCROLLBAR
Specifies that we want no Vertical scrolling or scroll Bar
NOHSCROLL | NOHSCROLLBAR
Specifies that we want no Horizontal scrolling or scroll Bar


PROPERTIES:

·   Value
Set / Gets RichEditBox value.
·   Enabled
Set / Gets enabled state of a RichEditBox control
·   Visible
Set / Gets visible a RichEditBox control.
·   Row
Set / Gets row position of a RichEditBox control.
·   Col
Set / Gets column position of a RichEditBox control.
·   Width
Set / Gets width of a RichEditBox control.
·   Height
Set / Gets height of a RichEditBox control.
·   FontName
Set / Gets RichEditBox control's font name.
·   FontSize
Set / Gets RichEditBox control's font size.
·   FontBold
Set / Gets RichEditBox control's font bold property
·   FontItalic
Set / Gets RichEditBox control's font italic property
Set / Gets RichEditBox control's font underline property
Set / Gets RichEditBox control's font strikeout property
·   FontColor
Set / Gets the foreground color for text within the RichEditBox
·   BackColor
Set / Gets the background color for text within the RichEditBox
·   ToolTip
Set / Gets RichEditBox control's Tooltip text.
·   Cargo
Set / Gets user property 'Cargo' for RichEditBox control
·   Name (R)
Retrieves the name of a RichEditBox control.
·   Parent (D)
Set the name as character identifier of the parent window.
·   HelpId (D)
Set the numeric help topic identifier of the control.
·   AutoFont
Set /Gets autofont property, if this flag is set, the RichEditBox automatically changes fonts when the user explicitly changes to a different keyboard layout.
·   ReadOnly (D)
Set the RichEditBox control's readonly property
·   MaxLength (D))
 
·   NoTabStop (D)
Sets whether an element behavior can't receive focus and participate in the tabbing sequence
·   RichValue
 
·   RichValue(nType)
 
·   Break (D)
Control passes to the statement that follows the terminated statement.

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

Values of nType:

1
RICHVALUE_TEXT
ANSI characters only
2
RICHVALUE_RTF
RTF format *** DEFAULT ***
3
RICHVALUE_UNICODE_TEXT
Unicode text, UTF-16LE
4
RICHVALUE_UTF8_TEXT
Unicode text, UTF-8
5
RICHVALUE_UTF8_RTF
UTF-8 RTF format
6
RICHVALUE_UTF7_TEXT
Unicode text, UTF-7


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.
·   OnScroll
Action to be performed when scrolling the control

METHODS:

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


EXAMPLE:

            See demo in :
                  
\Samples\Basic\RichEdit