show / hide menu

CheckBox

A checkbox control is a user interface element that allows users to select or deselect one or more independent options.

It typically appears as a small square box that can be checked or unchecked to represent a binary choice, and it can also be displayed as a toggle option using template options.

Control Name: Checkbox
Group: Standard

General
S.No	Property Name	Data Type	Description
1	Control Name	String	Specifies the unique identifier for the Checkbox control within a form
2	Control Type	String	Indicates the type of control.
3	ID	Integer	Uniquely identifies a Checkbox control in the form.
4	Text	String	String value that specifies the text displayed beside the checkbox, helping the user understand what option the checkbox represents.
5	Tooltip	String	Used to provide additional information or guidance about the checkbox when the user hovers the mouse pointer over it.
6	Tab Index	Integer	Determines the order in which controls receive focus when the user presses the Tab key on the keyboard.
7	Default Value	String	Determines whether the checkbox is checked or unchecked when a new form is first opened.
8	Remarks	String	Allows you to add descriptive notes or comments for a CheckBox control.
9	Check Dirty	Boolean	Used to determine whether a control’s value has been modified since it was last saved or loaded.

Style
S.No	Property Name	Data Type	Description
10	Width	Integer	Specifies how wide the checkbox control is on a form
11	Height	Integer	Determines how tall the checkbox appears on the form.
12	Margin	Integer	Specifies the amount of space between the control’s border and its contents.
13	Text Padding	Integer	Specifies the spacing between the checkbox square and the associated text label.
14	Padding	Integer	Defines the space between the Checkbox control’s border and its content, including the checkbox square and text label.
15	V Text Alignment	String	Specifies the vertical alignment of the text relative to the checkbox square.
16	Box Shadow	String	Specifies the shadow effect applied to the Checkbox control.
17	Enable Custom Font	Boolean	Determines whether the Checkbox control uses a custom font instead of the default system font.
18	Font	Boolean	Specifies the appearance of the text label associated with the checkbox.
19	Font Size	Integer	Specifies the size of the text label associated with a CheckBox control.
20	Font Color	String	Specifies the color of the text label associated with a CheckBox control.
21	Background Color	String	Specifies the color of the background of a CheckBox control.
22	Visible	Boolean	Determines whether the checkbox is shown or hidden on the form.
23	Enable	Boolean	Specifies whether the checkbox is interactive or non-interactive.
24	Bold	Boolean	Specifies whether the label text is displayed in bold.
25	Italic	Boolean	Determines whether the text label of a CheckBox control is displayed in italic font style.
26	Template	String	To set a different template(toggle) design for the checkbox control.

Attached Label
S.No	Property Name	Data Type	Description
27	Show Label	Boolean	Determines whether the attached label is visible or hidden.
28	Label Text	String	Determines the text displayed next to the checkbox.
29	Label Position	String	Determines the placement of the label relative to the checkbox control.
30	Label Width	Integer	Specifies the horizontal width of the label that is attached to the Checkbox control.
31	Label Height	Integer	Specifies the vertical height of the label that is attached to the Checkbox control.
32	Text Alignment	String	Specifies the horizontal alignment of the text relative to the checkbox square. It controls whether the checkbox label text appears left, center, or right aligned within the control.
33	V Text Alignment	String	Used to specify the vertical alignment of the text associated with the checkbox relative to the checkbox itself.
34	Margin	Integer	Defines the space between the label and surrounding elements.
35	Padding	Integer	Specifies the space between the checkbox’s content (text) and the edges of the control.
36	Box shadow	String	Allows you to apply a shadow effect around the checkbox control
37	Font	String	Determines the appearance of the text displayed next to the checkbox.
38	Font Size	Integer	Specifies the size of the text in the label attached to a checkbox.
39	Bold	Boolean	Determines whether the text in the attached label of a checkbox is displayed in bold.
40	Italic	Boolean	Determines whether the text in the attached label of a checkbox is displayed in italic style.
41	Underline	Boolean	Determines whether the text in the attached label of a checkbox is underlined.
42	Font Color	String	Determines the color of the text in the label attached to a checkbox.
43	Background Color	String	Determines the color displayed behind the checkbox control, including its box and the area around it.

Rules
S.No	Property Name	Data Type	Description
44	Rules		After selecting the control, if the user clicks the Rules tab it will be expanded and displays a Rules property. Create Rule can be selected from a drop-down list. On clicking the Create Rule link button will navigate the user to the Rules Engine. The same control will be added as a trigger by default to execute the Rule.

Validation
S.No	Property Name	Data Type	Description
45	Is Required	Boolean	Specifies whether the CheckBox must have at least one selected item for validation to succeed.
46	Required Message	String	Specifies the error message displayed when the CheckBox is required but has no selected value.
47	Message Position	String	Determines the placement of the error or validation message relative to the control being validated.

Reports
S.No	Property Name	Data Type	Description
48	Control Report		The Control Report redirects to the Reports tab, displaying all configurations, rules, and datasource details associated with the selected control.

Template
S.No	Property Name	Data Type	Description
49	Inherit Template	Boolean	Determines whether a control inherits a template definition from its parent control or base class.

Custom Style
S.No	Property Name	Data Type	Description
50	CSS Class	String	Specifies the CSS class or classes to apply to a control when it is rendered in HTML.

Custom Property
S.No	Property Name	Data Type	Description
51	HTML Attribute		Allows you to add or modify HTML attributes for a control when it is rendered.

Responsive Options
S.No	Property Name	Data Type	Description
52	Template Name	String	Represents the template name of the control shown in the Responsive UI configuration. The template name is same as the control’s name.
53	Max Width (px)	Integer	Specifies the maximum width, in pixels, that the control can occupy in the responsive form.