Text

A control for adding some text.

Text

Related sample:  All dhxForm inputs - DHTMLX Form

Adding Text

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

var form = new dhx.Form("form_container", {
    rows: [
        {
            type: "text",
            label: "text",
            labelInline: true,                      
            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"
  • id - (string) the id of a control, auto-generated if not set
  • value - (string) the value of a text control

  • 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
  • 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
  • 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 Text

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

List of the control methods:

  • clear() - clears a value of a Text control
  • getValue(): string - returns the current string value of a Text control
  • setValue(value: string) - sets the value as a string for a Text control
  • setConfig(config: object) - sets a new configuration for a Text control

Setting configuration of Text control

It is possible to update the configuration of a Text 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("text_id").setConfig({
    label: "text input",
    labelInline: true,
    labelWidth: "120px",
    value: "I am textinput!",
});

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

Back to top