|
A square box, in which an "X" appears when selected. The CHECKBOX offers a way to present a variety of options. Each CHECKBOX has its own specific information. Variable, Value and Text are all different, allowing the user to select more than one. Any number may be marked or left unmarked.
A CHECKBOX can have a value of 0 (unchecked) or 1 (checked). Each checkbox in a dialog should use a unique Variable.
Normally, when a dialog box opens, every CHECKBOX defaults to being unchecked. You can change this by assigning a value of 1 to the variable before calling the Dialog function.
Note: for advanced users only: it is possible to define a group of checkboxes which have the same "variable". Each box in the group must have a unique value, which must be a power of 2 (1, 2, 4, etc.). The user can check and uncheck individual checkboxes in the group, and when the Dialog function exits, the value of the variable will be equal to the values of all the checkboxes in the group combined using the bitwise OR operator (|).
Return Value:
The CHECKBOX control will return the user’s selection in the variable you supply as the Variable attribute in the control’s definition. The value 1 indicates the control was checked, and 0 indicates the control was not checked.
Control Definition:
<dlg-variable>nn =`x, y, width, height, type, control-name, variable, text, value, tab-order, style, font, textcolor, backgroundcolor`
For Example:
MyDialog003=`007,007,044,DEFAULT,CHECKBOX,"CheckBox_1",cbVariable1,"Check 1",1,30,DEFAULT,DEFAULT,DEFAULT,DEFAULT`
|
Attribute
|
Value
|
Meaning
|
|
dlg-variable
|
MyDialog
|
The name of the dialog box.
|
|
nn
|
003
|
The ordinal position of the control in the dialog box (starting with 1).
|
|
x
|
007
|
The horizontal coordinate of the upper left corner of the control in Dialog Units.
|
|
y
|
007
|
The vertical coordinate of the upper left corner of the control in Dialog Units.
|
|
width
|
044
|
The width of the control in Dialog Units
|
|
height
|
DEFAULT
|
The height of the control in Dialog Units.[This should be DEFAULT for this control]
|
|
type
|
CHECKBOX
|
The type of control.
|
|
control-name
|
"CheckBox_1"
|
The name used to identify the control in a user defined callback procedure. The name cannot be more than 30 characters in length and MUST be unique. ( This attribute can only be used with 6.2 or later dialog formats. )
|
|
variable
|
cbVariable1
|
The name of the variable affected by the control.
|
|
text
|
"Check 1"
|
The description which will be displayed with the control. [Use an empty string ("") if the control should appear blank.]
|
|
value
|
1
|
The value returned by the control. [Use only for pushbuttons, radiobuttons, and checkboxes.] Note: should be within the range of 0 - 127.
|
|
tab-order
|
30
|
Allows you to specify a control's tab order independently of a control's position or name in the dialog template. Tab-order controls the order in which controls are accessed when the keyboard is used to navigate the dialog. It also influences which control is on top when controls have overlapping positions in the dialog. It can be any positive integer, but each control should have a unique number.
When you navigate through a dialog using the tab key, lower number controls will be given the keyboard focus before higher controls. Likewise, low-numbered overlapping controls will appear on top of higher numbered controls. If you specify the DEFAULT keyword for this attribute or if you give two controls the same tab order, a tab order will be arbitrarily assigned to the control.
Note: The dialog function, under certain circumstances, may change the tab order you specify. The GROUPBOX controls tab order may be adjusted so that it is smaller than any of the controls it contains. In addition, the tab order of the controls inside the GROUPBOX may be adjusted so that they are consecutive.
|
|
style
|
DEFAULT
|
Allows you to control the initial appearance and behavior of your control. Numbers represent each style and they can be combined, using the bit-wise OR (|) operator, to set multiple styles. The following table lists the style constants and their meanings.
|
Style
|
Meaning
|
|
@csInvisible (1)
|
Control is invisible
|
|
@csDisabled (2)
|
Control has disabled appearance and does not accept any user input, it would otherwise accept input.
|
Note: Specifying 0 for this attribute is equivalent to using the DEFAULT keyword and means that the control will exhibit default behavior.
|
|
font
|
DEFAULT
|
The font used to display a control's text. The font description should be delimited by double quote (") marks unless the attribute is set to DEFAULT. If this attribute is set to DEFAULT, the font specified as the value of the main dialog font will be used. If the main dialog font is set to DEFAULT, the system font is used. You do not need to provide any value for this attribute unless you are also specifying text or background color. For details see the Dialog Fonts topic. WARNING: If a font is selected that doesn't exist on the user's system, a substitution will be made. We recommend using commonly available fonts.
|
|
textcolor
|
DEFAULT
|
The color of text associated with a control. Color is specified by three vertical bar (|) delimited numbers ranging from 0 to 255. The numbers represent one of the RGB colors: red, green or blue, in that order. The complete color specification must be surrounded by double quotes (") unless the DEFAULT key word is used. If this attribute is set to DEFAULT, the color listed in the main dialog's textcolor will be used. If a color is not specified for the dialog, the system text color will be used.
Note: A single hexadecimal number can be used instead of a vertical delimited list to indicate color. The hexadecimal number must be preceded by the letter "h" or "H". For exemple, "hFFFFF" is equivalent to "255|255|255"
|
|
backgroundcolor
|
DEFAULT
|
Used to change the color displayed behind a controls text. Color is specified by three vertical bar (|) delimited numbers ranging from 0 to 255. The numbers represent one of the RGB colors (red, green or blue, in that order). The complete color specification must be surrounded by double quotes (") unless the DEFAULT keyword is used. If no color is specified or the DEFAULT keyword is used the system background color will be used.
Note: A single hexadecimal number can be used instead of a vertical delimited list to indicate color. The hexadecimal number must be preceded by the letter "h" or "H". For exemple, "hcecece" is equivalent to "206|206|206"
|
|
Event Options
Use the DialogProcOptions function to control when your User-Defined-Callback procedure is called by its associated dialog. You can also use it to control your dialog's behavior, while your procedure is executing. You usually establish callback events during the first call to the procedure i.e., event 0, but this can be done during any call.
|
Event-Option-Code Values
|
Meaning
|
|
@deCbCheck (4)
|
Checkbox Checked/Unchecked: User has checked or unchecked a CHECKBOX control.
|
|
|
|
Dialog Callback Procedure Function Options
DialogControlGet function returns text and state information associated with a control.
|
Request
|
Meaning
|
|
@dcCheck (1)
|
1 box checked, 0 box unchecked.
|
|
@dcTitle (4)
|
Control’s title.
|
|
@dcBackColor (11)
|
Background color specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. If the control is using the system default color, the string "DEFAULT" is returned.
|
|
@dcTextColor (13)
|
Control's text color specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. If the control is using the dialog's default text color, the string "DEFAULT" is returned.
|
|
@dcPosition (17)
|
Space delimited list of a control's position and size in dialog units relative to the dialog's client area. The first two numbers are the horizontal and vertical location of the upper-left corner of the control while the third and fourth numbers are the width and height of the control.
|
|
@dcMenuNames (18)
|
Tab delimited list of menu item names associated with the control, menu item or menu bar.
|
|
@dchWnd (19)
|
Window handle of a dialog control.
|
|
|
|
DialogControlSet function changes the text or appearance of a control.
|
Request
|
Meaning
|
|
@dcCheck (1)
|
1 to check the box, 0 to uncheck the box.
|
|
@dcTitle (4)
|
Control’s title.
|
|
@dcBackColor (11)
|
Background color specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. If the control is using the system default color, the string "DEFAULT" is returned.
|
|
@dcTextColor (13)
|
Control's text color specified by three vertical bar (|) delimited numbers ranging from 0 to 255 or a single hexadecimal number preceded by the letter 'h'. If the control is using the dialog's default text color, the string "DEFAULT" is returned.
|
|
@dcPosition (17)
|
Space delimited list of a control's position and size in dialog units relative to the dialog's client area. The first two numbers are the horizontal and vertical location of the upper-left corner of the control while the third and fourth numbers are the width and height of the control.
|
|
|
|
DialogControlState function changes a control’s style or gives control input focus.
|
Style
|
Meaning
|
|
@csInvisible (1)
|
Control is invisible
|
|
@csDisabled (2)
|
Control has disabled appearance and does not accept any user input, it would otherwise accept input.
|
|
§ Dialog
§ Dialog Overview
§ Defining the Dialog
§ Defining the Dialog Controls
§ Dialog Control Types
§ Dynamic Dialogs
§ InternetExplorer Controls
§ Dialog Units
§ Dialog Fonts
Control Types
§ Calendar
§ Checkbox
§ ComControl
§ DropListbox
§ Editbox
§ FileListbox
§ Groupbox
§ Itembox
§ MenuBar
§ MenuItem
§ MultiLinebox
§ Picture
§ PictureButton
§ PushButton
§ RadioButton
§ ReportView
§ Spinner
§ StaticText
§ VaryText
|
