BCX_EDIT function

Purpose:

BCX_EDIT creates a multiline Edit control with auto-scrolling and a vertical scrollbar.

Syntax:

hCtl = BCX_EDIT(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 edit 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 Edit box.
Data type: HWND
hwndParent The handle of the parent window of the control being created.
Data type: INTEGER
hCtlID Specifies the identifier of the control being created. The identifier is an integer value used by the 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 control being created. Xpos The x-coordinate of the upper-left corner of the 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 control being created. Ypos The initial y-coordinate of the upper-left corner of the 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 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 control being created.
Data type: INTEGER
WinStyle [OPTIONAL] If the WinStyle parameter is used, the default Window Style for a BCX_EDIT control, WS_CHILD | WS_VISIBLE | ES_WANTRETURN | WS_VSCROLL | ES_MULTILINE | ES_AUTOVSCROLL | ES_AUTOHSCROLL | WS_TABSTOP, 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_EDIT control is WS_EX_CLIENTEDGE. For more information, visit the Microsoft Extended Window Styles webpage.

Remarks:

To tab forward out of the BCX_TAB control use the CTRL-TAB key combination.

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

The following example uses the MODSTYLE function to add a horizontal scrollbar to the edit control.

GUI "BCX_Edit", PIXELS
 
SUB FORMLOAD
  DIM Form1 AS CONTROL
  DIM Edit1 AS CONTROL
  DIM Focus AS HWND
  DIM Caption$
   
  Form1 = BCX_FORM("BCX_Edit", 0, 0, 235, 130)
  Caption$ = "Start Typing And Watch The ScrollBars"
  Edit1 = BCX_EDIT(Caption$, Form1, 12345, 0, 0, 220, 100)
  MODSTYLE(Edit1,WS_HSCROLL)
  CENTER(Form1)
  Focus = SetFocus(Edit1)
  SHOW(Form1)
END SUB
 
BEGIN EVENTS
END EVENTS

For another example using the BCX_EDIT function see Demo.bas.