Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Syntax

...

BA_createTextArea(label, defaultValue, isDisabled [, rows[, isRequired, fieldDescription]])

Description

...

Excerpt

Creates a textarea text area suitable for longer text values like comments.

Parameters

...

Parameter name

Type

Required

Description

label

string

Yes

Specifies a Field label for the field

defaultValue

string

Yes

Specifies a default value for the textareatext area

isDisabledbooleanYesSpecifies whether the input should be read-only or not.
rowsnumberNo

The initial height of the

textarea

text area (defaults to 5).

Some


Certain browsers

will

allow resizing.

isRequiredbooleanNoSpecifies if whether the field is should be marked as required with a dark red asterisk. Note that marking the field as required does not add any validation.
fieldDescriptionstringNoA description of the field to be displayed immediately under the input box.

Return type

...

string []

Examples

...

Code Block
BA_createTextArea("text 1", "", false , 5, false, "description 1");
BA_createTextArea("text 2", "mini textarea", false , 2, false, "description 2");
BA_createTextArea("text 3", "maxi textarea", true , 10, false, "description 3");

...