Check Box (DriveWorks Documentation)

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

Background Color
Specifies the color of the control's background.
Check Alignment
Controls whether the check box is on the left or right of the caption.
Check Background Color
Controls the background color of the check.
Check Background Color (Checked)
Controls the background color of the check when checked.
Check Background Color (Disabled)
Controls the background color of the check when disabled.
Check Mark Color
Controls the color of the check mark shown when checked.
Check Mark Color (Disabled)
Controls the color of the check mark shown when checked, and the control is disabled.
Check Opacity (Disabled)
Specifies the opacity of the check when the control is disabled, between 0 and I00.
Check Size
Controls the size of the check in the check box.
Show Check
Specifies whether to show the check box.
Vertical Alignment
Specifies whether the control's content is vertically aligned to the top, bottom or center of its bounds.

Check Border Color
Controls the border color of the check.
Check Border Color (Checked)
Controls the border color of the check when checked.
Check Border Color (Disabled)
Controls the border color of the check when disabled.
Check Border Radius
Controls the border radius of the check.
Check Border Width
Controls the border width of the check.

Caption
Controls the control's caption.
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

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).

Macro Argument
Provides an optional argument to the macro
On Change
Determines the name of the macro to fire when the value of this control changes.

(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.

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

DriveWorks Pro 22 Check Box