TextArea class

Inheritance MovieClip > UIObject class > UIComponent class > View > ScrollView > TextArea

ActionScript Class Name mx.controls.TextArea

The properties of the TextArea class let you set the text content, formatting, and horizontal and vertical position at runtime. You can also indicate whether the field is editable, and whether it is a "password" field. You can also restrict the characters that a user can enter.

Setting a property of the TextArea class with ActionScript overrides the parameter of the same name set in the Property inspector or Component inspector.

The TextArea component overrides the default Flash Player focus rectangle and draws a custom focus rectangle with rounded corners.

The TextArea component supports CSS styles and any additional HTML styles supported by Flash Player.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.TextArea.version);

NOTE

The code trace(myTextAreaInstance.version); returns undefined.

Method summary for the TextArea class

There are no methods exclusive to the TextArea class.

Methods inherited from the UIObject class

The following table lists the methods the TextArea class inherits from the UIObject class. When calling these methods from the TextArea object, use the form TextAreaInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the TextArea class inherits from the UIComponent class. When calling these methods from the TextArea object, use the form TextAreaInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Property summary for the TextArea class

The following table lists properties of the TextArea class.

Property	Description
TextArea.editable	A Boolean value indicating whether the field is editable (`true`) or not (`false`).
TextArea.hPosition	Defines the horizontal position of the text in the field.
TextArea.hScrollPolicy	Indicates whether the horizontal scroll bar is always on (`"on"`), is never on (`"off"`), or turns on when needed (`"auto"`).
TextArea.html	A Boolean value that indicates whether the text area contents can be formatted with HTML.
TextArea.length	Read-only; the number of characters in the text area.
TextArea.maxChars	The maximum number of characters that the text area can contain.
TextArea.maxHPosition	Read-only; the maximum value of TextArea.hPosition.
TextArea.maxVPosition	Read-only; the maximum value of TextArea.vPosition.
TextArea.password	A Boolean value indicating whether the field is a password field (`true`) or not (`false`).
TextArea.restrict	The set of characters that a user can enter in the text area.
TextArea.styleSheet	Attaches a style sheet to the specified TextArea component.
TextArea.text	The text contents of a TextArea component.
TextArea.vPosition	A number indicating the vertical scrolling position.
TextArea.vScrollPolicy	Indicates whether the vertical scroll bar is always on (`"on"`), is never on (`"off"`), or turns on when needed (`"auto"`).
TextArea.wordWrap	A Boolean value indicating whether the text wraps (`true`) or not (`false`).

Properties inherited from the UIObject class

The following table lists the properties the TextArea class inherits from the UIObject class. When accessing these properties from the TextArea object, use the form TextAreaInstance.propertyName.

Property	Description
UIObject.bottom	Read-only; the position of the bottom edge of the object, relative to the bottom edge of its parent.
UIObject.height	Read-only; the height of the object, in pixels.
UIObject.left	Read-only; the left edge of the object, in pixels.
UIObject.right	Read-only; the position of the right edge of the object, relative to the right edge of its parent.
UIObject.scaleX	Read-only; a number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	Read-only; the position of the top edge of the object, relative to its parent.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	Read-only; the width of the object, in pixels.
UIObject.x	Read-only; the left edge of the object, in pixels.
UIObject.y	Read-only; the top edge of the object, in pixels.

Properties inherited from the UIComponent class

The following table lists the properties the TextArea class inherits from the UIComponent class. When accessing these properties from the TextArea object, use the form TextAreaInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Event summary for the TextArea class

The following table lists the event of the TextArea class.

Event	Description
TextArea.change	Notifies listeners that text has changed.
TextArea.scroll	Notifies listeners that text has scrolled.

Events inherited from the UIObject class

The following table lists the events the TextArea class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the TextArea class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Version 8

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00004043.html