Text

A control for adding some text.

Text

Adding Text

You can easily add a Text control during initialization of a form:

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

Attributes

You can provide the following attributes in the configuration object of a Text:

type	(string) the type of a control, set it to "text"
inputType	(string) sets the type of an input: "text", "password", "number". Using the "number" type for the input sets the type of the value attribute to "number". Use the "password" value to specify a field for entering a password.
name	(string) the name of a control
id	(string) the id of a control, auto-generated if not set
value	(string\|number) the value of a text control
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
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 control is hidden
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

Working with Text

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

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

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

List of the control methods:

clear	clears a value of a Text control
disable	disables a Text control on a page
enable	enables a disabled Text control
getProperties	returns an object with the available configuration attributes of the control
getValue	returns the current value of a Text control
hide	hides a Text control
isDisabled	checks whether a Text control is disabled
isVisible	checks whether a Text control is visible on the page
setProperties	allows changing available configuration attributes of the control dynamically
setValue	sets the value for a Text control
show	shows a Text control on the page

List of the control events:

afterChangeProperties	fires after configuration attributes of the control have been changed dynamically
afterHide	fires after a control is hidden
afterShow	fires after a control is shown
afterValidate	fires after the control value is validated
beforeChangeProperties	fires before configuration attributes of the control are changed dynamically
beforeHide	fires before a control is hidden
beforeShow	fires before a control is shown
beforeValidate	fires before the control value is validated
change	fires on changing the value of a control