User Guide

918 Chapter 2: ActionScript Language Reference
TextField.setTextFormat()
Availability
Flash Player 6.
Usage
my_txt.setTextFormat (textFormat:TextFormat) : Void
my_txt.setTextFormat (index:Number, textFormat:TextFormat) : Void
my_txt.setTextFormat (beginIndex:Number, endIndex:Number,
textFormat:TextFormat) : Void
Parameters
textFormat
A TextFormat object, which contains character and paragraph formatting
information.
index An integer that specifies a character within my_txt.
beginIndex An integer.
endIndex An integer that specifies the first character after the desired text span.
Returns
Nothing.
Description
Method; applies the text formatting specified by textFormat to some or all of the text in a text
field.
textFormat must be a TextFormat object that specifies the text formatting changes desired.
Only the non-null properties of textFormat are applied to the text field. Any property of
textFormat that is set to null will not be applied. By default, all of the properties of a newly
created TextFormat object are set to
null.
There are two types of formatting information in a TextFormat object: character level, and
paragraph level formatting. Each character in a text field might have its own character formatting
settings, such as font name, font size, bold, and italic.
For paragraphs, the first character of the paragraph is examined for the paragraph formatting
settings for the entire paragraph. Examples of paragraph formatting settings are left margin, right
margin, and indentation.
The
setTextFormat() method changes the text formatting applied to an individual character, to
a range of characters, or to the entire body of text in a text field.
Usage 1: Applies the properties of
textFormat to all text in the text field.
Usage 2: Applies the properties of
textFormat to the character at position index.
Usage 3: Applies the properties of the
textFormat parameter to the span of text from the
beginIndex parameter to the endIndex parameter.