BCX_RICHEDIT function

Purpose: BCX_RICHEDIT creates a multiscrolling richtext box. The maximum text size it can hold by default is 1,048,576 bytes.


 Syntax:

 hCtl = BCX_RICHEDIT(Text$, _
                 hWndParent, _
                    hCtlID%, _
                      Xpos%, _
                      Ypos%, _
                     Width%, _
                    Height%  _
                [,WinStyle%] _
              [,ExWinStyle%])

 Parameters:

  • hCtl The return value is a handle to the new richedit control if the function succeeds. If the function fails, the return value is NULL.
  • Text$ Default string to be placed in richedit control.
  • hWndParent Handle to the parent window of the richedit control being created.
  • hCtlID% Specifies the identifier of the richedit control being created. The identifier is an integer value used by the richedit control being created to notify its parent about events. The identifier must be unique for each control created with the same parent window.
  • Xpos% Specifies the initial horizontal position of the richedit control being created. X% is the x-coordinate of the upper-left corner of the richedit control being created relative to the upper-left corner of the parent window's client area.
  • Ypos% Specifies the initial vertical position of the richedit control being created. Y% is the initial y-coordinate of the upper-left corner of the richedit control being created relative to the upper-left corner of the parent window's client area.
  • Width% Specifies the width, in device units or, if the PIXELS optional parameter was specified in the GUI statement, in pixels , of the richedit control being created.
  • Height% Specifies the height, in device units or, if the PIXELS optional parameter was specified in the GUI statement, in pixels , of the richedit control being created.
  • WinStyle% [OPTIONAL] If the WinStyle% parameter is used, the default Window Style for a BCX_RICHEDIT control, WS_CHILD | WS_CLIPSIBLINGS | WS_VISIBLE | WS_HSCROLL | WS_VSCROLL | ES_MULTILINE | ES_AUTOVSCROLL | ES_AUTOHSCROLL | ES_WANTRETURN, is replaced with the value in WinStyle%. See your Win32 SDK or PSDK Reference help for more information about valid Window Styles.
  • ExWinStyle% [OPTIONAL] The default Extended Window Style for a BCX_RICHEDIT control is WS_EX_CLIENTEDGE. See your Win32 SDK or PSDK Reference help for more information about valid Extended Window Styles.

Remarks: To tab forward out of the BCX_RICHEDIT control use the SHIFT-TAB key combination.

The default window Style for a BCX_RICHEDIT control also can be changed by using the MODSTYLE function.

For an example of the BCX_RICHEDIT function see Demo.bas in the BCX\Gui_Demo\EZ_Gui folder.