CheckboxGroup

A control intended for creating groups of checkboxes.

CheckboxGroup control

Related sample:  Checkbox group - DHTMLX Form

Adding CheckboxGroup

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

var form = new dhx.Form("form_container", { 
    rows: [
        {
            id: "checkboxGroup",
            type: "checkboxGroup",
            name: "checkboxGroup",
            required: true,
            label: "Checkbox Group",
            labelWidth: 140,
            labelPosition: "left",
            helpMessage: "Help information",
            padding: "50px",
            value: {
                first: true,
            },
            options: {
                padding: "50px",
                rows: [
                    {
                        id: "first",
                        type: "checkbox",
                        text: "Select 1",
                    },
                    {
                        id: "second",
                        type: "checkbox",
                        text: "Select 2",
                        checked: true
                    }
                ]
            }
        }
     ]
});

Attributes

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


Attributes of Checkbox

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


Working with CheckboxGroup

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

For example, you can hide a control on a page:

var value = form.getItem("CheckboxGroup").hide();

List of the control methods:

clear clears a value of a CheckboxGroup control
clearValidate clears validation of a CheckboxGroup control
disable disables a CheckboxGroup control on a page
enable enables a disabled CheckboxGroup control
focus sets focus to the checkbox of the Checkbox control by its id
getProperties returns an object with the available configuration attributes of the control
getValue returns the current value/state of a checkbox(s)
hide hides a CheckboxGroup control
isChecked checks whether a checkbox of the CheckboxGroup control is checked
isDisabled checks whether a CheckboxGroup control is disabled
isVisible checks whether a CheckboxGroup control is visible on the page
setProperties allows changing available configuration attributes of the control dynamically
setValue sets the value for a CheckboxGroup control
show shows a CheckboxGroup control on the page
validate validates a CheckboxGroup 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
Back to top