Checkbox

A checkbox is a component that accepts a boolean value (true/false). It is true when the checkbox is checked and false when it is not selected.

Note

Multiple checkboxes select from a list of options, whereas a checkbox takes its value as the true or false value of the checkbox.

Properties

No	Item	Input Value	Default Value	Action Property	Type	Action Default Value	Description
1	ID	String	Auto-generated	id	string		Component unique identifier
2	Label L	String	Checkbox	label	string	Checkbox	Component label
3	Width	String	222	width	string	222	Component width
4	Height	String	40	height	string	40	Component height
5	X	String		x	string		X coordinate position
6	Y	String		y	string		Y coordinate position
7	Lock	Boolean	OFF	lock	boolean	false	When ON, the component stays fixed even when the screen is scrolled. When OFF, the component moves along with the screen scroll. Added in v4.1.0.
8	Size	Selection 1. Small 2. Medium 3. None	Medium	size	string	medium	When a value other than None is selected, Font Size is disabled. Added in v4.2.0.
9	Font Size	Number	16	fontSize	number	16	Font size for label and checkbox. Only effective when Size is set to None. Added in v4.2.0.
10	Color	String Color Picker		color	string		Component color
11	Background Color	String Color Picker		backgroundColor	string		Background color
12	Label Color	String Color Picker		labelColor	string		Label text color
13	Disabled	Boolean	OFF	disabled	boolean	false	Disabled state
14	Read Only	Boolean	OFF	readOnly	boolean	false	Read-only mode
15	Required	Boolean	OFF	required	boolean	false	Required input setting
16	Visibility	Boolean	ON	visibility	boolean	true	Visibility state
17	Horizontal Alignment	Selection 1. Left 2. Center 3. Right	Left	horizontalAlignment	string	left	Horizontal alignment
18	Vertical Alignment	Selection 1. Top 2. Center 3. Bottom	Top	verticalAlignment	string	top	Vertical alignment
19	Helper Text	String		helperText	string		Helper text
20	Icon	Selection		icon	string		Component icon
21	Value	Boolean	TRUE	value	boolean	true	Component value
22	Error			error	boolean	false	Error state
23	Change Event	Selection 1. None 2. UI Script 3. Action 4. Detached Action	None				Event on value change Detached Action became selectable in v4.1.0. UI Script became selectable in v4.2.0.
24	Detached Action	Selection 1. [Detached Action ID]		detachedAction	string		Set a detached action Added in v4.1.0.
25	Tab Focus	Selection 1.[Component ID]		tabFocus	string		Component specification for next focus

Note

• ^L: This is a Multilingual Property.
• Icons are highlighted depending on the value ON/OFF. The choices are limited to only checkable icons.
• The following can be entered for the "Width" and "Height" property values:
  • If you want to display in px, specify only numerical values; if you want to display in %, specify % as the unit.
  • Operation will not be supported if you enter anything other than the following:
    • number
    • number%
    • calc() function
• The following can be entered for the [X] and [Y] property values:
  • If you want to display in px, specify only numerical values.
  • Operation will not be supported if you enter anything other than the following:
    • number
    • calc() function
• The calc() function is a CSS function that enables calculations. (e.g. calc(100% - 30px))
  • The units that can be used with the calc() function are "%" and "px".
  • Other units (e.g., em, rem, etc.) are not supported.
• When the calc() function is used to specify the size, the appearance in the editor may differ from the appearance in the application.
  • Please confirm using the preview.
• The [Size] property can be set from actions with the following values:
  • small
  • medium
  • none
• The color you specify for "Background Color" will be reflected in the □ frame of the checkbox.

Event

Event name	Description
onchange	Occurs when a value change is made.