(VTS Library)
Description: Parameter Setting Checkbox. This module draws a checkbox with (optional) label.
Returns: Nothing
Usage: Steady State
Format: \DialogLibrary\PCheckbox(ParmNum [, Label, BoxOnLeft, Alignment, FocusID, PrivNotReq])
Parameters: ParmNum { numeric } { required } { no default }
Any numeric expression giving the parameter number (from 0) in the caller to alter.
Label { text } { optional } { default: "" }
An optional parameter that is any text expression to be used as a label with the checkbox. The default value is a blank label.
BoxOnLeft { numeric } { optional } { default: TRUE }
An optional parameter that is any logical expression; if true (non-0) the checkbox will appear to the left of the label, if false (0) it will be to the right. The default value is true.
Alignment { numeric } { optional } { default: 0 }
An optional parameter that is any numeric expression that sets the alignment of the checkbox and its label according to one of the following options:
|
Alignment |
Horizontal Alignment |
Vertical Alignment |
|
0 |
Left |
Top |
|
1 |
Right |
Top |
|
2 |
Full |
Top |
|
3 |
Left |
Centered |
|
4 |
Right |
Centered |
|
5 |
Full |
Centered |
|
6 |
Left |
Bottom |
|
7 |
Right |
Bottom |
|
8 |
Full |
Bottom |
FocusID { numeric } { optional } { default: see note }
An optional parameter that is any numeric expression for the focus number of this graphic. If this value is 0, the checkbox will display its current setting, but will not be able to be set and will appear grayed out.
If this parameter is omitted or invalid, the next available focus ID will be assigned.
PrivNotReq { Boolean } { optional } { default: FALSE }
An optional parameter that is any logical expression. If set to true (non-0), anyone can change the value in this editfield. If set to false (0), only those users whose user accounts have been granted the "TagModify" privilege may set it. The default value is false.
Comments: This module is a member of the VTS Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary\.
The "P" tools (PCheckbox, PContributor, PColorSelect, PDroplist, and PEditfield) were intended only for use in configuration folders and drawing panel modules, and therefore are subject to the system security restraints.
This parameter tool expects the first parameter of its calling module to contain an array of tag parameters. It will then set the element indicated by ParmNum to the logical value set by the checkbox.
The size of the checkbox is constant, with the boundaries of its calling transform defining the position of the checkbox and its label.
For any optional parameter that is to be set, all optional parameters preceding the desired one must be present, although they may be invalid.
Examples:
GUITransform(70, 190, 210, 170,
1, 1, 1, 1, 1,
0, 0, 1, 0,
0, 0, 0,
\DialogLibrary\PCheckbox(3 { Parm num },
"Invert Output" { Label },
0 { Box on right },
2 { Full, top alignment },
4 { Focus ID }));
See Also:
PAreaSelect | PColorSelect | PContributor | PDroplist | PEditfield | PPageSelect | PRadioButtons | PSecBit | PSelectObject | PSpinbox | PTypeToggle