Check Box
The Check Box control displays an image of a box
alongside a caption by
default.
When the control is selected (or checked) in the running of a
specification or testing the image shows a check mark
within
the box.
When the form control is created the name given to the control
will display as its caption. This can be changed by selecting the
Caption property.
The caption can be displayed either side of the check box by
changing the Check Alignment property.
This form control is typically used for:
- Making a Yes/No selection or a number of Yes/No selections.
- Invoking Form Navigation Decisions.
- Disabling Form Controls.
- Overriding default values.
Return value
When selected (checked) the form control reports
TRUE.
When unselected (not checked) the form control reports
FALSE.
Any rule that references the check box return value should use these values.
Properties
Appearance
Appearance - Border
Appearance - Caption
- Caption
Controls the control's caption.
The text displayed in this property can have formatting tags applied to decorate parts of the text string, see Formatting the Displayed Text below for more information.
- Caption Color
Controls the caption color of the control.
- Caption Font
Determines the font used for the controls caption.
- Caption Horizontal Alignment
Controls whether the text inside the caption is horizontally aligned to the left, right or center
Appearance - Picture
Behavior
- Checked
Controls whether the check box is checked.
- Checked (Override Rule)
Controls whether the check box is checked.
- Default Value
Controls the default value of the control. If the default value is based on a rule and the value
changes, then the value of the control will be changed to be the new default value.
- Enabled
Controls whether the control is enabled (if the result is TRUE) or disabled (if the result is
anything other than TRUE, e.g. FALSE).
- Error Result
Determines whether the value of the control is in error. The result of this rule is a string
containing the error message if the value is in error, otherwise a blank string or the number zero.
- Tab Index
Configures the position of the control in the form tab order.
- Visible
Determines whether the control is visible (TRUE) or hidden (FALSE).
Events
General
- (Metadata)
Optional text which can be used to provide information belonging to or about a control. For example,
a list of CSS classes which can be parsed and applied to the control using the Integration Theme in
DriveWorks Live. This doesn't affect the control's behavior.
- (Name)
The name of the control
- (Tag)
Optional text which can be used to describe the control, but which doesn't affect the control's
behavior.
- Tooltip Duration
Controls the duration, in seconds, for which the tooltip will remain visible. Values of 0 and below
indicate an infinite duration.
- Tooltip Text
Specifies the text to display in a tooltip when hovering over the control.
The text displayed in this property can have formatting tags applied to decorate parts of the text string, see Formatting the Displayed Text below for more information.
Layout
- Height
Controls the height of the control.
- Left
Controls the left position of the control.
- Top
Controls the top position of the control.
- Width
Controls the width of the control.
Formatting the Displayed Text
Formatting Text
The text displayed in the Caption and Tooltip Text property support the use of formatting tags to format parts of the text string.
The supported tags are:
- Bold
- Italic
- Underline
- Color
- Url (not supported for Tooltip Text)
For example:

See How To: Format Text for more information.
Convert Check Box
Convert Check Box to Toggle Switch
Any Check Box control added to a user form can be converted to a Toggle Switch control.
- In Form Design, right click on the Check Box control to be converted.
- Select Convert > To ToggleSwitch

- The Check Box will convert to a Toggle Switch.
All properties common to both controls will be retained.
If the original Check Box is required to be reinstated, use the Undo button from the command bar (or the keyboard shortcut Ctrl + Z)

A user form control which displays a check mark when selected.
The check box reports TRUE when selected and FALSE when not
selected.