Checkbox

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

Checkbox control

Related sample:  All dhxForm inputs - DHTMLX Form

Related sample:  Checkboxes - DHTMLX Form

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",
            labelInline: true,
            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"
  • id - (string) the id of a control, auto-generated if not set
  • checked - (boolean) defines the initial state of a checkbox
  • value - (string) the value of a checkbox
  • hidden - (boolean) defines whether a checkbox is hidden

  • parent - (string) the id of the parent control
  • width - (string) the width of a control
  • height - (string) the height of a control
  • css - (string) adds style classes to a control
  • disabled - (boolean) defines whether a control is enabled (false) or disabled (true)
  • label - (string) specifies a label for a control
  • labelWidth - (string) sets the width of the label of a control
  • hiddenLabel - (boolean) invisible label that will be used to identify the input on the server side
  • labelInline - (boolean) defines the position of a label: true - to set a label inline with a control
  • name - (string) the name of a control
  • required - (boolean) defines whether a control is required
  • help - (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
  • gravity - (boolean) arranges form controls evenly throughout the container, depending on the direction of layout ("cols" or "rows"), true by default

Working with Checkbox

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

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

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

List of the control methods:

  • clear() - clears a value of a Checkbox control
  • clearValidate() - clears validation of a Checkbox control
  • getValue(): boolean - returns the current boolean value of a Checkbox control
  • setValue(value: boolean) - sets the boolean value for a Checkbox control
  • setConfig(config: object) - sets a new configuration for a Checkbox control
  • validate(): boolean - validates a Checkbox control. Returns the result of validation: true, if a control is valid, otherwise - false

Setting configuration of Checkbox control

It is possible to update the configuration of a Checkbox control on the fly with the help of the setConfig() method of the object returned by the getItem() method.

To do this, you need to get access to the object of the control by using the getItem() method of Form and pass a new configuration object as a parameter of the setConfig() method:

form.getItem("checkbox_id").setConfig({
    label: "I agree",
    labelWidth: "120px",
    required: true,
    value: "checkboxvalue",
    labelInline: true,
    checked: true
});

The setConfig() method of a control doesn't allow updating its id, type and name properties.

Back to top