Skip to main content

getProperties()

returns an object with the available configuration attributes of the control

getProperties(): ITextProps;

Returns:

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

Example

const form = new dhx.Form("form_container", {
rows: [
{
type: "text",
name: "text",
label: "text",
value: "I am a nice text"
}
]
});

form.getItem("text").getProperties();

// the returned object
{
height: "content",
helpMessage: "",
hiddenLabel: false,
inputType: "text",
label: "text",
labelPosition: "top",
labelWidth: "",
padding: 0,
width: "content"
}

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

inputType(string) the type of an input: "text", "password", "number".
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 Text control
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

Change log:

added in v7.0