Checkbox

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

Checkbox control

Related sample:  Form. All DhxForm Inputs

Related sample:  Form. Checkboxes

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"
  • 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) 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)
  • hidden - (boolean) defines whether a checkbox is hidden
  • required - (boolean) defines whether a control is required
  • gravity - (boolean) arranges form controls evenly throughout the container, depending on the direction of layout ("cols" or "rows"), true by default
  • 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: "right"|"bottom"
  • 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 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
  • disable() - disables a Checkbox control on a page
  • enable() - enables a disabled Checkbox control
  • getValue(): boolean - returns the current boolean value of a Checkbox control
  • hide() - hides a Checkbox control
  • isDisabled(): boolean - checks whether a Checkbox control is disabled
  • setValue(value: boolean) - sets the boolean state for a Checkbox control
  • show() - shows a Checkbox control on the page
  • validate(): boolean - validates a Checkbox control. Returns the result of validation: true, if a control is valid, otherwise - false
Back to top