User Guide

660 ActionScript classes

■ Usage 3:my_textField.getTextFormat(beginIndex:Number,endIndex:Number)

Returns a TextFormat object containing formatting information for the span of text from

beginIndex to endIndex. Only properties that are common to all of the text in the

specified range is set in the resulting TextFormat object. Any property that is mixed (it has

different values at different points in the range) has its value set to null.

Availability: ActionScript 1.0; Flash Lite 2.0

Parameters

beginIndex:Number [optional] - An integer that specifies a character in a string. If you do

not specify

beginIndex and endIndex, the TextFormat object returned is for the entire

Te xt Fi e ld .

endIndex:Number [optional] - An integer that specifies the end position of a span of text. If

you specify

beginIndex but do not specify endIndex, the TextFormat returned is for the

single character specified by

beginIndex.

Returns

TextFormat - An object.

Example

The following ActionScript traces all of the formatting information for a text field that is

created at runtime.

this.createTextField("dyn_txt", this.getNextHighestDepth(), 0, 0, 100,

200);

dyn_txt.text = "Frank";

dyn_txt.setTextFormat(new TextFormat());

var my_fmt:TextFormat = dyn_txt.getTextFormat();

for (var prop in my_fmt) {

trace(prop+": "+my_fmt[prop]);

}