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 AS STRING, _
                 hwndParent AS HWND, _
                  hCtlID AS INTEGER, _
                    Xpos AS INTEGER, _
                    Ypos AS INTEGER, _
                   Width AS INTEGER, _
                  Height AS INTEGER  _
             [, WinStyle AS INTEGER] _
           [, ExWinStyle AS INTEGER])

Return Value:

  • Data type: HWND
    hCtl The handle of the new richedit control if the function succeeds. If the function fails, the return value is NULL.

Parameters:

  • Data type: STRING
    Text Default string to be placed in richedit control.
  • Data type: HWND
    hwndParent The handle of the parent window of the richedit control being created.
  • Data type: INTEGER
    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.
  • Data type: INTEGER
    Xpos Specifies the initial horizontal position of the richedit control being created. Xpos 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.
  • Data type: INTEGER
    Ypos Specifies the initial vertical position of the richedit control being created. Ypos 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.
  • Data type: INTEGER
    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.
  • Data type: INTEGER
    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.
  • Data type: INTEGER
    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. For more information, visit the Microsoft Edit Control Styles webpage and the Microsoft Window Styles webpage.
  • Data type: INTEGER
    ExWinStyle [OPTIONAL] The default Extended Window Style for a BCX_RICHEDIT control is WS_EX_CLIENTEDGE. For more information, visit the Microsoft Extended Window Styles webpage.

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.