Flash Lite 2

Flash Lite 2.x ActionScript Language Reference > ActionScript classes > TextField > setTextFormat (TextField.setTextFormat method)

setTextFormat (TextField.setTextFormat method)

Applies the text formatting specified by the textFormat parameter 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:my_textField.setTextFormat(textFormat:TextFormat)

  Applies the properties of textFormat to all text in the text field.

• Usage 2:my_textField.setTextFormat(beginIndex:Number, textFormat:TextFormat)

  Applies the properties of textFormat to the character at the beginIndex position.

• Usage 3:my_textField.setTextFormat(beginIndex:Number, endIndex:Number, textFormat:TextFormat)

  Applies the properties of the textFormat parameter to the span of text from the beginIndex position to the endIndex position.

Notice that any text inserted manually by the user receives the text field's default formatting for new text, and not the formatting specified for the text insertion point. To set a text field's default formatting for new text, use TextField.setNewTextFormat().

Availability: ActionScript 1.0; Flash Lite 2.0

Parameters

beginIndex:Number [optional] - An integer that specifies the first character of the desired text span. If you do not specify beginIndex and endIndex, the TextFormat is applied to the entire TextField.

endIndex:Number [optional] - An integer that specifies the first character after the desired text span. If you specify beginIndex but do not specify endIndex, the TextFormat is applied to the single character specified by beginIndex.

textFormat:TextFormat - A TextFormat object, which contains character and paragraph formatting information.

Example

The following example sets the text format for two different strings of text. The setTextFormat() method is called and applied to the my_txt text field.

var format1_fmt:TextFormat = new TextFormat();
format1_fmt.font = "Arial";
var format2_fmt:TextFormat = new TextFormat();
format2_fmt.font = "Courier";

var string1:String = "Sample string number one."+newline;
var string2:String = "Sample string number two."+newline;

this.createTextField("my_txt", this.getNextHighestDepth(), 0, 0, 300, 200);
my_txt.multiline = true;
my_txt.wordWrap = true;
my_txt.text = string1;
var firstIndex:Number = my_txt.length;
my_txt.text += string2;
var secondIndex:Number = my_txt.length;

my_txt.setTextFormat(0, firstIndex, format1_fmt);
my_txt.setTextFormat(firstIndex, secondIndex, format2_fmt);

See also

, TextFormat, setNewTextFormat (TextField.setNewTextFormat method)