PCheckBox

(Dialog Library)

Description:

Parameter Setting check box. This module draws a check box with optional label.
Returns Nothing
Usage:: Steady State only.
Function Groups: Graphics
Related to: GUITransform | PAddressEntry | PAlmPriority | PAreaSelect | PColorEdit | PColorSelect | PContributor | PDroplist | PEditField | PEditName | PFileChooser | PHSliderBar | PHueSelect | PImageSelect | PIPAddressList | PIPListenerGroup | PMultiCheckBox | PPageSelect | PPhraseEdit | PRadioButtons | PSecBit | PSelectObject | PServerListName | PSpinbox | PTimeZone | PTypeToggle | SiteDispParms
Format: \DialogLibrary.PCheckBox(ParmNum [, Label, BoxOnLeft, Alignment, FocusID, PrivNotReq])
Parameters:  
ParmNum
Required. Any numeric expression giving the parameter number (from 0) in the caller to alter.
Label
An optional parameter that is any text expression to be used as a label with the check box. The default value is a blank label.
BoxOnLeft
An optional parameter that is any logical expression. If TRUE (non-0) the check box will appear to the left of the label, if FALSE (0) it will be to the right. The default value is TRUE.
Alignment
An optional parameter that is any numeric expression that sets the alignment of the check box 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
Boolean. If this value is FALSE (0), the field will display its current setting, but cannot be opened (i.e. its value cannot be changed), and will appear disabled (grayed-out).
PrivNotReq
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 VTScada Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary\.
The "P" tools (Pcheck box, 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 check box.
The size of the check box is constant, with the boundaries of its calling transform defining the position of the check box and its label.

Usual height: 12 pixels.

Examples:

  GUITransform(70, 190, 210, 170,
               1, 1, 1, 1, 1,
               0, 0, 1, 0,
               0, 0, 0,
               \DialogLibrary.PCheckBox(3         { Parm num            },
                                        \GetPhrase("YourLabel") { Label },
                                        FALSE     { Box on right        },
                                        2         { Full, top alignment },
                                        TRUE      { Focus ID            }));