CONTROL ADD LINE

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > CONTROLS > Control Types > Line Control > Line Control Creation >

CONTROL ADD LINE

 

Description

 

Create a new line control inside a dialog.

 

Syntax

 

hndl = CONTROL ADD LINE [Name ControlName], hwnd, ctrlID, txt, xPos, yPos, Width, Height [, [Style] [, [ExStyle]]] [[,] CALL CallBack]

 

Returns

 

Number

Control window handler.

 

Parameters

 

Name

Type

Optional

Meaning

ControlName

String

Yes

Optional name for the control.

 

This name must be globally unique, and is used to create a global variable to be used with control name methods and properties.

hwnd

Number

No

Handle of the dialog containing the control

ctrlID

Number

No

Control identifier

txt

String

No

A text expression representing the text you want to assign to the control.

A line control does not display text, so it is possible to use this string for your own purposes

xPos

Number

No

Horizontal position of the control inside the dialog

yPos

Number

No

Vertical position of the control inside the dialog

Width

Number

No

Control width

Height

Number

No

Control height

Style

Number

Yes

Primary style of the control. See LINE Style equates.

ExStyle

Number

Yes

Extended style of the control. See LINE ExStyle equates.

CallBack

Function

Yes

Optional name of a Callback Function that receives all %WM_COMMAND and %WM_NOTIFY messages for the control.

 

If the Callback Function processes a message, it should return %TRUE (non-zero) to prevent the message being passed unnecessarily to the dialog callback (if one exists).

 

The dialog callback should also return %TRUE if the notification message is processed by that Callback Function.

 

Remarks

 

A line control will only send messages to a callback if the %SS_NOTIFY style is used. The following notifications are sent to the Callback Function:

 

%STN_CLICKEDSent when the user clicks a mouse button, or activates the button with the hot-key (unless the button has been disabled).
%STN_DBLCLKSent when the user double-clicks on a label control (unless the control has been disabled).
%STN_DISABLESent when a button is disabled.
%STN_ENABLESent when a label control has been enabled.

 

When a Callback Function receives a %WM_COMMAND message, it should explicitly test the value of CBCTL and CBCTLMSG to guarantee it is responding appropriately to the notification message.

 

Restrictions

 

See also

 

Examples