BCX_LABEL function

Purpose: BCX_LABEL creates a simple rectangle and left-aligns the text in the rectangle. The text is formatted before it is displayed. Words that extend past the end of a line are automatically wrapped to the beginning of the next left-aligned line. Words that are longer than the width of the control are truncated.


 Syntax: 

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

 Parameters:

  • Text$ Label text.
  • hWndParent Handle to the parent window of the label being created.
  • hCtlID% Specifies the identifier of the label being created. The identifier is an integer value used by the label 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 label being created. X% is the x-coordinate of the upper-left corner of the label being created relative to the upper-left corner of the parent window's client area.
  • Ypos% Specifies the initial vertical position of the label being created. Y% is the initial y-coordinate of the upper-left corner of the label 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 label being created. If the width is equal to zero, the label will be resized automatically to accommodate the width of the caption.
  • Height% Specifies the height, in device units or, if the PIXELS optional parameter was specified in the GUI statement, in pixels , of the label being created.
  • WinStyle% [OPTIONAL] If the WinStyle% parameter is used, the default Window Style for a BCX_LABEL control, WS_CHILD | SS_NOTIFY | SS_LEFT | WS_VISIBLE, 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_LABEL control is 0. See your Win32 SDK or PSDK Reference help for more information about valid Extended Window Styles.

 Return Value:

  • hCtl, the return value, is a handle to the new label if the function succeeds. If the function fails, the return value is NULL.

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

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