Checkbox

Show allHide all

Lets the user choose between two boolean values using a checkbox.

If you need to force the user to check the checkbox then you should use a Consent Checkbox instead.

Start value: 0, '' (empty string) or NULL means unchecked, everything else means checked.
Return value: 0 for unchecked, 1 for checked.
Supported in: NewEdit Parameter page Multirow

Appearance

alt text
An example of a checked and an unchecked checkbox.

Default value

SQL Call: Default value

Retrieves the default value for the control.

May modify database: No

Resultset: Default value

Table count: repeated exactly once
Row count: exactly one row

Columns

<column with ordinal 1> mandatory string
The default value

Validation

SQL Call: Validation

This call is only made if there is a field validation set for the field info and the field has any content.

Live Validation

Performs field validation when the user leaves the field or one of its dependencies is changed, initial values set by default value and initial values in edit-mode are not validated.

Save Validation

When saving the validation runs server side if the field value has changed. A field value is considered changed if in new mode the value is anything other than NULL. In edit mode it is considered changed if it has a value that was not returned by the GetEditFields procedure.

May modify database: No

Parameters

@Value string
The value of the field, the procedure will not be called if value is NULL.

Resultset: Validation messages (optional)

Table count: repeated zero or one time
Row count: zero or one row

Columns

Error optional string
Error message to display. Blocks the user from saving.
Info optional string
Informative message to display. Does not block saving.