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

Textarea control

Related sample:  Form. All DhxForm Inputs

Related sample:  Form. Textareas

Adding Textarea

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

var form = new dhx.Form("form_container", {
    rows: [
            type: "textarea",
            label: "textarea",
            labelInline: true,
            labelWidth: "70px",
            value: "Some nice text",


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

  • type - (string) the type of a control, set it to "checkbox"
  • 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 - (object|function) the rule of input validation. Can be set in two ways:
    • as an object with validation rules listed below:
      • "" - empty
      • "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) the width of a control
  • height - (string) the height of a 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"
  • 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
  • gravity - (boolean) arranges form controls evenly throughout the container, depending on the direction of layout ("cols" or "rows"), true by default

Working with Textarea

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

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

var value = form.getItem("textarea_id").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
  • getValue(): string - returns the current string value of a Textarea control
  • hide() - hides a Textarea control
  • isDisabled(): boolean - checks whether a Textarea control is disabled
  • setValue(value: string) - sets the value as a string for a Textarea control
  • show() - shows a Textarea control on the page
  • validate(): boolean - validates a Textarea control. Returns the result of validation: true, if a control is valid, otherwise - false
Back to top