47
CHECK_BOX Directive
Control Check Box
Formats
1. Define/Create: CHECK_BOX [*]ctl_id,@(col,ln,wth,ht)=contents$[,ctrlopt]
2. Remove: CHECK_BOX REMOVE [*]ctl_id[,ERR=stmtref]
3. Disable/Enable: CHECK_BOX {DISABLE | ENABLE}[*]ctl_id[,ERR=stmtref]
4. Hide/Show: CHECK_BOX {HIDE | SHOW} [*]ctl_id[,ERR=stmtref]
5. Force Focus: CHECK_BOX GOTO [*]ctl_id[,ERR=stmtref]
6. Signal on Focus: CHECK_BOX SET_FOCUS ctl_id,ctl_val[,ERR=stmtref]
7. Logical On/Off: CHECK_BOX {ON | OFF} [*]ctl_id[,ERR=stmtref]
8. Read Activation Status: CHECK_BOX READ [*]ctl_id,state$[,mode$][,ERR=stmtref]
9. Update: CHECK_BOX WRITE [*]ctl_id,state$[,ERR=stmtref]
Where
*
Optional. Use a leading asterisk to denote a global check box.
@(col,ln, Position and size of the check box region. Numeric expressions. Column
wth,ht)
and line coordinates for top left corner, width in number of columns and
height in number of lines. Note that width and height are for the total
area (box plus text/description). Use line value -1 to display the check
box on the tool bar.
contents$ Text/pictures to appear on the check box. {bitmap} and {icon} images
are supported. String expression. See CHECK_BOX contents$, p.49
ctl_id
Unique logical identifier for the check box (any integer -32000 to +32000).
Avoid integers that conflict with keyboard definitions (e.g., 4 cancels CTL=4
the apostrophe operator to access various Check Box Properties.
Control options. Supported options for CHECK_BOX include:
ctrlopt
ERR=stmtref Error transfer
FNT="font,size[,attr]" Font name, size, optional properties
Refer to the 'FONT' Mnemonic, p.607 for details.
MSG=text$ Message string.
MNU=ctl CTL value associated with right-click menu event.
OWN=name$ Name assigned for automated testing of this control.
TBL=char$ Single character translation
TIP=text$ Mouse pointer message.
To change the colour, refer to the 'TC'= System Parameter, p.686.
ctl_val
CTL value to generate when focus goes to the input field.
mode$
String variable. ProvideX returns a single-character hex value in this
variable to report the last method / keystroke the user chose to toggle
the check box ($01$ for MOUSE-CLICK or $0D$ for Enter ).