Textarea

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

Textarea control

Related sample:  Textareas - DHTMLX Form

Related sample:  All dhxForm inputs - DHTMLX Form

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",
            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 "checkbox"
  • id - (string) the id of a control, auto-generated if not set
  • 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.
  • value - (string) the initial value of the textarea
  • placeholder - (string) a tip for the textarea
  • errorMessage - (string) a message that appears in case of error during validation of the control value
  • success - (boolean) defines whether a textarea and its label are highlighted in case of successful validation
  • readOnly - (boolean) defines whether a textarea is readonly
  • resizable - (boolean) adds a resizer icon into a textarea, if set to true

  • parent - (string) the id of the parent control
  • 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)
  • label - (string) specifies a label for a control
  • labelWidth - (string) 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
  • labelInline - (boolean) defines the position of a label: true - to set a label inline with a control
  • name - (string) the name of a control
  • required - (boolean) defines whether a control is required
  • help - (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
  • 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
  • getValue(): string - returns the current string value of a Textarea control
  • setValue(value: string) - sets the value as a string for a Textarea control
  • setConfig(config: object) - sets a new configuration for a Textarea control
  • validate(): boolean - validates a Textarea control. Returns the result of validation: true, if a control is valid, otherwise - false

Setting configuration of Textarea control

It is possible to update the configuration of a Textarea control on the fly with the help of the setConfig() method of the object returned by the getItem() method.

To do this, you need to get access to the object of the control by using the getItem() method of Form and pass a new configuration object as a parameter of the setConfig() method:

form.getItem("textarea_id").setConfig({
    label: "textarea",
    help: "Help information",
    required: true,
    labelInline: true,
    labelWidth: "120px",
    value: "I am textarea!"
});

The setConfig() method of a control doesn't allow updating its id, type and name properties.

Back to top