Skip to main content

getProperties()

returns an object with the available configuration attributes of the control

getProperties(): ICheckboxProps;

Returns:

An object with the available attributes of the control and their values.

Example

var form = new dhx.Form("form_container", {    rows: [        {               type: "checkbox",            label: "I agree",            name: "agree",            id: "agree",            value: "checkboxvalue"        }    ]});
form.getItem("checkbox").getProperties();
// -> the returned object:{    errorMessage: "",    height: "content",    helpMessage: "",    hiddenLabel: false,    label: "",    labelPosition: "top",    labelWidth: "",    padding: 0,    preMessage: "",    required: false,    successMessage: "",    text: "I agree",    width: "content"}

The returned object of the Checkbox control can contain the following configuration attributes:

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
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

Change log:

added in v7.0