TextArea

The TextArea component is a wrapper of the TextArea field that can perform some basic validations, such as IsBlank and maxChars.

Properties

name

• Description: (REQUIRED) Enter unique name of the control. Must exactly match the name of the corresponding JavaScript object on the page.
• Type: String
• Default Value: TextArea1
• Method: getName()
• Method: setName()

textAreaName

• Description: (REQUIRED) Enter unique name of TextArea form tag. Must not match the 'name' property.
• Type: String
• Default Value: TextAreaName1

formName

• Description: (REQUIRED) The name of the form in which the component resides.
• Type: String
• Default Value: Form1

defaultValue

• Description: The initial value that appears in the TextArea field when rendered.
• Type: String

rows

• Description: The height of the TextArea field, measured in rows of text.
• Type: Number
• Default Value: 4

cols

• Description: The width of the TextArea field, measured in characters across.
• Type: Number
• Default Value: 50

wrap

• Description: The text wrapping mode.
• Value Set: off|soft|hard
• Type: String
• Default Value: soft

validate

• Description: Validate the text input? False indicates that Is Required and Max Characters properties should be ignored.
• Value Set: true|false
• Type: Boolean
• Default Value: false

isRequired

• Description: Is this a required field (cannot be blank)?
• Value Set: true|false
• Type: Boolean
• Default Value: false

maxChars

• Description: Max. Number of characters allowed in the field. Value of 0 indicates no limit applies.
• Type: Number
• Default Value: 0

state

• Description: Select the textbox state.
• Value Set: editable|read-only|hidden
• Default Value: editable
• Type: String

testMode

• Description: Select the test mode.
• Value Set: off|alerts|text
• Type: String
• Default Value: off
• Is Expert: Yes

Methods

Get Value

• Name: getValue()
• Description: Gets the current value of the element.

Set Value

• Name: setValue()
• Description: Sets the current value of the element.

Render

• Name: render()
• Description: Renders the TextArea in HTML.

Validate Value

• Name: validateValue()
• Description: Validates the current value of the element.

Events

On Render

• Name: onBlur()
• Description: Fires after the render method has been called.

On Change

• Name: onChange()
• Description: Fires after a user changes the contents.

On Focus

• Name: onFocus()
• Description: Fires after the render method has been called.

On Invalid

• Name: onInvalid()
• Description: Event handler fires after the value of the field is validated and errors are found.

On Key Down

• Name: onKeyDown()
• Description: Event handler fires after a key is pressed down.

On Key Press

• Name: onKeyPress()
• Description: Event handler fires after a key is pressed.

Key Up

• Name: onKeyUp()
• Description: Event handler fires after a key after a key is pressed and then let go.

On Render

• Name: onRender()
• Description: Fires after the render method has been called.

On Select

• Name: onSelect()
• Description: Event handler fires after a block of text is selected inside the TextArea field.

On Valid

• Name: onValid()
• Description: Event handler fires after the value of the field is validated and no errors are found.

On Validate

• Name: onValidate()
• Description: Event handler fires after validating the value of the field regardless of whether or not errors are found.

Other Information

Environment: Client