Purpose |
Add a line control to a dialog. A line control may also be a rectangle (empty or filled). | ||||||||||||||||||||||||
Syntax |
CONTROL ADD LINE, hDlg, id&, txt$, x, y, xx, yy [, [style&] [, [exstyle&]]] [[,] CALL callback] | ||||||||||||||||||||||||
hDlg |
Handle of the dialog in which the line will be created. The dialog will become the parent of the control. | ||||||||||||||||||||||||
id& |
Unique identifier for the control in the range 1 to 65535, frequently specified with numeric equates for clarity of the code. For example, the equate %SeparatorLeft is more informative than a literal value such as 497. If you will not be changing the text in a line control after it is created, you may use -1 for the id& however, best practice suggests identifiers should start at 100 to avoid conflict with any of the standard predefined identifiers. | ||||||||||||||||||||||||
txt$ |
Text to associate with the line control. A line control does not display text, so it is possible to use this string for your own purposes; however, an ampersand (&) may be included in txt$ to specify a hot-key. See the Remarks section below. | ||||||||||||||||||||||||
x, y |
| ||||||||||||||||||||||||
xx |
Integer expression, variable, or numeric literal value, specifying the width of the control. The width is given in the same terms (pixels or dialog units) as the parent dialog. The most common value used in the Microsoft Dialog Editor and Visual Studio is 40 dialog units. | ||||||||||||||||||||||||
yy |
Integer expression, variable, or numeric literal value, specifying the height of the control. The height is given in the same terms (pixels or dialog units) as the parent dialog. The most common value used in the Microsoft Dialog Editor and Visual Studio is 1 dialog unit. | ||||||||||||||||||||||||
style& |
Primary style of the line control. The default line style is %SS_ETCHEDFRAME. The default style is used if both the primary and extended style parameters are omitted from the statement. For example: CONTROL ADD LINE, hDlg, id&, "", 100, 100, 150, 1, , , _ CALL LineCallback() ' Use default styles Custom style values replace the default values. That is, they are not additional to the default style values - your code must specify all necessary primary and extended style parameters. The primary line style value can be a combination of any values below, combined together with the OR operator to form a bitmask:
| ||||||||||||||||||||||||
exstyle& |
Extended style of the line control. The default extended line style comprises %WS_EX_LEFT. The default extended style is used if both the primary and extended parameters are omitted from the CONTROL ADD LINE statement, in the same manner as style& above. The extended line control style value can be a combination of any values below, combined together with the OR operator to form a bitmask:
| ||||||||||||||||||||||||
callback |
Optional name of a Callback Function that receives all %WM_COMMAND and %WM_NOTIFY messages for the control. See the #MESSAGES metastatement to choose which messages will be received. If a callback for the control is not designated, you must create a dialog Callback Function to process messages from your control. The Callback Function will only receive messages if the %SS_NOTIFY style is used. 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. Otherwise, the DDT engine processes unhandled messages. | ||||||||||||||||||||||||
Remarks |
If the ampersand (&) character appears in the txt$ parameter, the letter that follows will be displayed underscored. This adds a control accelerator (hot-key) to enable the user to directly "click" the control that immediately follows in the Tab-Order after the Line control, simply by pressing and holding the ALT key while pressing the specified hot-key. For example, "&Test Suite " makes ALT+T the hot-key. 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:
When a Callback Function receives a %WM_COMMAND message, it should explicitly test the value of CB.CTL and CB.CTLMSG to guarantee it is responding appropriately to the notification message. | ||||||||||||||||||||||||
See also |