EditINICheckBox

(VTScada Library)

Description:	Draws an edit field check box, with which a value of an application property in Settings.Dynamic may toggled between true and false.
Returns:	Nothing
Usage:	Steady State only.
Function Groups:	Graphics
Related to:	EditINI | ReadINI | ReadSectINI | WriteSectINI
Format:	\Library\EditINIcheck box(Section, VarName [, Title, BoxOnLeft, Align, FocusID, UpdateVar, EnableIfEditing])
Parameters:

Section

Required. Any text expression giving the name of the section in the file. This should not include the square brackets delimiting the section.

VarName

Required. Any text expression giving the name of the variable for which the value is to be set.

Title

Optional. Any text expression to be used as a title for the field. No default:

BoxOnLeft

Optional. A Boolean, indicating whether the check box should be to the left or right of the label.  Defaults to TRUE (box to the left of the label).

Align

Optional. Any numeric expression controlling the alignment of the label and the box. Defaults to 3 - Left, vertically centered. Value Meaning 0 Left, top. 1 Right, top. 2 Full, top. 3 Left, vertically centered. 4 Right, vertically centered. 5 Full, vertically centered. 6 Left, bottom. 7 Right, bottom. 8 Full, bottom.

FocusID

Optional. Any numeric expression from 0 to 32767 for the focus number of this graphic. If this value is 0, the check box will display its current setting, but its value will not be able to be changed and it will appear grayed out. The default value is 1.

UpdateVar

Obsolete. The running system is always updated.

EnableIfEditing

Obsolete. Will always evaluate to FALSE. Within the Idea Studio, EditINICheckbox will always be disabled. Everywhere else, it will be enabled.

Comments:

This module is a member of the VTScada Library and must therefore be called from within a GUITransform and prefaced by \Library\.

Example:

GUITransform(495, 375, 595, 345,
               1, 1, 1, 1, 1 { Scaling              },
               0, 0          { Movement             },
               1, 0          { Visibility, Reserved },
               0, 0, 0       { Selectability        },
              \Library\EditIniCheckBox("System", "AlarmPopupsEnable", "Alarm Popups", 
               TRUE, 3, 1, Invalid, FALSE));

This draws a check box that operators may use to enable or disable the Alarm Popups application property.