Skip to main content

getProperties()

returns an object with the available configuration attributes of the control

getProperties(): IInputProps;

Returns:

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

Example

var form = new dhx.Form("form_container", {    rows: [        {            type: "input",            name: "input",            label: "Name",            icon: "dxi dxi-magnify",            placeholder: "John Doe"                   }     ]});
form.getItem("input").getProperties();// -> the returned object{    autocomplete: false,    errorMessage: "",    height: "content",    helpMessage: "",    hiddenLabel: false,    icon: "dxi dxi-magnify",    inputType: "text",    label: "Name",    labelPosition: "top",    labelWidth: "",    max: undefined,    maxlength: undefined,    min: undefined,    minlength: undefined,    padding: 0,    placeholder: "John Doe",    preMessage: "",    readOnly: false,    required: false,    successMessage: "",    validation: undefined,    width: "content"    }

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

inputType(string) the type of an input: "text", "password", "number"
min(string|number) the minimal value allowed in the input.
The attribute works only with the input type: "number".
max(string|number) the maximal value allowed in the input.
The attribute works only with the input type: "number".
validation(object|function) the rule of input validation
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 the Input control
minlength(string|number) the minimum number of characters allowed in the input.
The attribute works with the following input types: "text", "password".
maxlength(string|number) the maximum number of characters allowed in the input.
The attribute works with the following input types: "text", "password".
required(boolean) defines whether a control is required
readOnly(boolean) defines whether an input is readonly
icon(string) the name of an icon from the used icon font
placeholder(string) a tip for the input
autocomplete(boolean) enables/disables the autocomplete functionality of the input
label(string) specifies a label for a control
labelWidth(string|number) 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
labelPosition(string) defines the position of a label: "left"|"top"
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