Checkbox

From HSYCO
Jump to: navigation, search
Note  For a description and a complete list of UI Objects, see UI Objects.

Checkbox button that allows the user to set a value to true or false. Can be used with a submit button.

Requires an ID.

For a tutorial on using this object, see Working with Forms

UI Object checkbox.png

Parameters

  • id: the object's ID, used by UISets
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • label: the text label next to the button. Can contain HTML tags
  • css: optional. Defines the CSS style for the label

Syntax

(checkbox!id <position>; <label>; [<css>])

E.g.

(checkbox!mycheckbox r1c1; label; color:black)

UI Attributes

Common attributes

Name Value Description
pos x<x>y<y> Position specified as x/y coordinates. E.g. x-5y10
visible true Default. Show the object
false Hide the object
blink true | slow Blink the object at a slow speed
fast Blink the object at a fast speed
false Stop the blinking
opacity 0.0 ... 1.0 Object opacity from 0 (not visible) to 1 (fully visible)
rotation 0 ... 360 Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner

Field attributes

Name Value Description
enabled true Field is enabled
false Field is disabled
autosend true Automatically sends the value on changes. It's the default behaviour when there are no submit objects on the page or in a parent container (if the field is inside a container).
false Won't send the value on changes. It's the default behaviour when there's a submit object on the page or in a parent container.
focus true Focus the field. Only a single object should have this attribute at "true".
false Reset focus
rollback true Restores the previously saved value.
rollbackenabled true Automatically restores the previous value on an error (if the value isn't valid or the remote request resolved in an error).
false Won't restore the value on errors.
error true Manually shows an error feedback on the field (won't modify the current field value).
false Hides the error visualization.

Checkbox attributes

Name Value Description
value true | 1 Checked (case insensitive)
false | 0 Not checked (case insensitive)