Checkbox

A control that allows a user to make a choice between one or several opposite options by toggling them.

Checkbox control

Adding Checkbox

You can easily add a Checkbox control during initialization of a form:

var form = new dhx.Form("form_container", {
    rows: [
        {   
            type: "checkbox",
            label: "I agree",
            name: "agree",
            id: "agree",
            value: "checkboxvalue"
        }
    ]
});

Attributes

You can provide the following attributes in the configuration object of a Checkbox:

type	(string) the type of a control, set it to "checkbox"
name	(string) the name of a control
id	(string) the id of a control, auto-generated if not set
value	(string) the value of a checkbox
checked	(boolean) defines the initial state of a checkbox
width	(string\|number\|"content") the width of a control
height	(string\|number\|"content") the height of a control
padding	(string\|number) sets padding between a cell and a border of a Checkbox control
css	(string) adds style classes to a control
disabled	(boolean) defines whether a control is enabled (false) or disabled (true)
hidden	(boolean) defines whether a checkbox is hidden
required	(boolean) defines whether a control is required
text	(string) optional, the text value of a control. It's placed to the right of the control.
label	(string) specifies a label for a control
hiddenLabel	(boolean) invisible label that will be used to identify the input on the server side
labelPosition	(string) defines the position of a label: "left"\|"top"
labelWidth	(string\|number) sets the width of the label of a control
helpMessage	(string) adds a help message to a control
preMessage	(string) a message that contains instructions for interacting with the control
successMessage	(string) a message that appears in case of successful validation of the control value
errorMessage	(string) a message that appears in case of error during validation of the control value

Working with Checkbox

You can manipulate a Checkbox control by using methods (or events) of the object returned by the getItem() method.

For example, you can get the value of the control:

var value = form.getItem("checkbox").getValue();

List of the control methods:

clear	clears a value of a Checkbox control
clearValidate	clears validation of a Checkbox control
disable	disables a Checkbox control on a page
enable	enables a disabled Checkbox control
focus	sets focus to a control
getProperties	returns an object with the available configuration attributes of the control
getValue	returns the current value/state of a Checkbox control
hide	hides a Checkbox control
isChecked	checks whether a Checkbox control is checked
isDisabled	checks whether a Checkbox control is disabled
isVisible	checks whether a Checkbox control is visible on the page
setProperties	allows changing available configuration attributes of the control dynamically
setValue	sets the state for a Checkbox control
show	shows a Checkbox control on the page
validate	validates a Checkbox control

List of the control events:

afterChangeProperties	fires after configuration attributes of the control have been changed dynamically
afterHide	fires after a control is hidden
afterShow	fires after a control is shown
afterValidate	fires after the control value is validated
beforeChangeProperties	fires before configuration attributes of the control are changed dynamically
beforeHide	fires before a control is hidden
beforeShow	fires before a control is shown
beforeValidate	fires before the control value is validated
change	fires on changing the value of a control