Flash Lite 2.x and 3.0 ActionScript Language Reference

TextField 

Object
    |
    +-TextField

public dynamic class TextField
extends Object

The TextField class is used to create areas for text display and input. All dynamic and input text fields in a SWF file are instances of the TextField class. You can give a text field an instance name in the Property inspector and use the methods and properties of the TextField class to manipulate it with ActionScript. TextField instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box in the Actions panel.

To create a text field dynamically, you do not use the new operator. Instead, you use MovieClip.createTextField().

The methods of the TextField class let you set, select, and manipulate text in a dynamic or input text field that you create during authoring or at runtime.

See also

Object, createTextField (MovieClip.createTextField method)

Property summary

Modifiers

Property

Description

_alpha:Number

Sets or retrieves the alpha transparency value of the text field.

 

autoSize:Object

Controls automatic sizing and alignment of text fields.

 

background:Boolean

Specifies if the text field has a background fill.

 

backgroundColor:Number

The color of the text field background.

 

border:Boolean

Specifies if the text field has a border.

 

borderColor:Number

The color of the text field border.

 

bottomScroll:Number [read-only]

An integer (one-based index) that indicates the bottommost line that is currently visible the text field.

 

condenseWhite:Boolean

A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) in an HTML text field should be removed when the field is rendered in a browser.

 

embedFonts:Boolean

A Boolean value that specifies whether to render the text using embedded font outlines.

 

_height:Number

The height of the text field in pixels.

 

_highquality:Number

Deprecated since Flash Player 7. This property was deprecated in favor of TextField._quality.

Specifies the level of anti-aliasing applied to the current SWF file.

 

hscroll:Number

Indicates the current horizontal scrolling position.

 

html:Boolean

A flag that indicates whether the text field contains an HTML representation.

 

htmlText:String

If the text field is an HTML text field, this property contains the HTML representation of the text field's contents.

 

length:Number [read-only]

Indicates the number of characters in a text field.

 

maxChars:Number

Indicates the maximum number of characters that the text field can contain.

 

maxhscroll:Number [read-only]

Indicates the maximum value of TextField.hscroll.

 

maxscroll:Number [read-only]

Indicates the maximum value of TextField.scroll.

 

multiline:Boolean

Indicates whether the text field is a multiline text field.

 

_name:String

The instance name of the text field.

 

_parent:MovieClip

A reference to the movie clip or object that contains the current text field or object.

 

password:Boolean

Specifies whether the text field is a password text field.

 

_quality:String

Property (global); sets or retrieves the rendering quality used for a SWF file.

 

_rotation:Number

The rotation of the text field, in degrees, from its original orientation.

 

scroll:Number

Defines the vertical position of text in a text field.

 

selectable:Boolean

A Boolean value that indicates whether the text field is selectable.

 

_soundbuftime:Number

Specifies the number of seconds a sound prebuffers before it starts to stream.

 

tabEnabled:Boolean

Specifies whether the text field is included in automatic tab ordering.

 

tabIndex:Number

Lets you customize the tab ordering of objects in a SWF file.

 

_target:String [read-only]

The target path of the text field instance.

 

text:String

Indicates the current text in the text field.

 

textColor:Number

Indicates the color of the text in a text field.

 

textHeight:Number

Indicates the height of the text.

 

textWidth:Number

Indicates the width of the text.

 

type:String

Specifies the type of text field.

 

_url:String [read-only]

Retrieves the URL of the SWF file that created the text field.

 

variable:String

The name of the variable that the text field is associated with.

 

_visible:Boolean

A Boolean value that indicates whether the text field my_txt is visible.

 

_width:Number

The width of the text field, in pixels.

 

wordWrap:Boolean

A Boolean value that indicates if the text field has word wrap.

 

_x:Number

An integer that sets the x coordinate of a text field relative to the local coordinates of the parent movie clip.

 

_xmouse:Number [read-only]

Returns the x coordinate of the mouse position relative to the text field.

 

_xscale:Number

Determines the horizontal scale of the text field as applied from the registration point of the text field, expressed as a percentage.

 

_y:Number

The y coordinate of a text field relative to the local coordinates of the parent movie clip.

 

_ymouse:Number [read-only]

Indicates the y coordinate of the mouse position relative to the text field.

 

_yscale:Number

The vertical scale of the text field as applied from the registration point of the text field, expressed as a percentage.

Properties inherited from class Object

constructor (Object.constructor property), __proto__ (Object.__proto__ property), prototype (Object.prototype property), __resolve (Object.__resolve property)

Event summary

Event

Description

onChanged = function(changedField:TextField) {}

Event handler/listener; invoked when the content of a text field changes.

onKillFocus = function(newFocus:Object) {}

Invoked when a text field loses keyboard focus.

onScroller = function(scrolledField:TextField) {}

Event handler/listener; invoked when one of the text field scroll properties changes.

onSetFocus = function(oldFocus:Object) {}

Invoked when a text field receives keyboard focus.

Method summary

Modifiers

Signature

Description

 

addListener(listener:Object) : Boolean

Registers an object to receive TextField event notifications.

 

getDepth() : Number

Returns the depth of a text field.

 

getNewTextFormat() : TextFormat

Returns a TextFormat object containing a copy of the text field's text format object.

 

getTextFormat([beginIndex:Number], [endIndex:Number]) : TextFormat

Returns a TextFormat object for a character, for a range of characters, or for an entire TextField object.

 

removeListener(listener:Object) : Boolean

Removes a listener object previously registered to a text field instance with TextField.addListener().

 

removeTextField() : Void

Removes the text field.

 

replaceSel(newText:String) : Void

Replaces the current selection with the contents of the newText parameter.

 

replaceText(beginIndex:Number, endIndex:Number, newText:String) : Void

Replaces a range of characters, specified by the beginIndex and endIndex parameters, in the specified text field with the contents of the newText parameter.

 

setNewTextFormat(tf:TextFormat) : Void

Sets the default new text format of a text field.

 

setTextFormat([beginIndex:Number], [endIndex:Number], textFormat:TextFormat) : Void

Applies the text formatting specified by the textFormat parameter to some or all of the text in a text field.

Methods inherited from class Object

addProperty (Object.addProperty method), hasOwnProperty (Object.hasOwnProperty method), isPropertyEnumerable (Object.isPropertyEnumerable method), isPrototypeOf (Object.isPrototypeOf method), registerClass (Object.registerClass method), toString (Object.toString method), unwatch (Object.unwatch method), valueOf (Object.valueOf method), watch (Object.watch method)