Textarea

A control that allows a user to enter a simple multi-line text.

Textarea control

Adding Textarea

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

var form = new dhx.Form("form_container", {
    rows: [
        {
            type: "textarea",
            name:"textarea",
            label: "textarea",
            labelWidth: "70px",
            value: "Some nice text",
            width:400
        }
    ]
});

Attributes

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

type	(string) the type of a control, set it to "textarea"
name	(string) the name of a control
id	(string) the id of a control, auto-generated if not set
value	(string) the initial value of the textarea
validation	(string,function) the rule of input validation. Can be set in two ways: as a predefined string value: - "email" - validEmail - "integer" - validInteger - "numeric" - validNumeric - "alphanumeric" - validAplhaNumeric - "IPv4" - validIPv4 as a function that defines a custom validation rule. It takes as a parameter the value typed in the input and returns true, if the entered value is valid.
placeholder	(string) a tip for the textarea
readOnly	(boolean) defines whether a textarea is readonly
resizable	(boolean) adds a resizer icon into a textarea, if set to true
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 Textarea control
minlength	(string\|number) the minimum number of characters allowed in the textarea
maxlength	(string\|number) the maximum number of characters allowed in the textarea
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"
required	(boolean) defines whether a control is required
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 Textarea

You can manipulate a Textarea 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("textarea").getValue();

List of the control methods:

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

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
input	fires when a user types some text in the textarea