TextFormat constructor

public TextFormat([font:String], [size:Number], [color:Number], [bold:Boolean], [italic:Boolean], [underline:Boolean], [url:String], [target:String], [align:String], [leftMargin:Number], [rightMargin:Number], [indent:Number], [leading:Number])

Creates a TextFormat object with the specified properties. You can then change the properties of the TextFormat object to change the formatting of text fields.

Any parameter may be set to null to indicate that it is not defined. All of the parameters are optional; any omitted parameters are treated as null.

Parameters

color:Number [optional] - The color of text using this text format. A number containing three 8-bit RGB components; for example, 0xFF0000 is red, and 0x00FF00 is green.

bold:Boolean [optional] - A Boolean value that indicates whether the text is boldface.

italic:Boolean [optional] - A Boolean value that indicates whether the text is italicized.

underline:Boolean [optional] - A Boolean value that indicates whether the text is underlined.

url:String [optional] - The URL to which the text in this text format hyperlinks. If url is an empty string, the text does not have a hyperlink.

target:String [optional] - The target window where the hyperlink is displayed. If the target window is an empty string, the text is displayed in the default target window _self. If the url parameter is set to an empty string or to the value null, you can get or set this property, but the property will have no effect.

align:String [optional] - The alignment of the paragraph, represented as a string. If "left", the paragraph is left-aligned. If "center", the paragraph is centered. If "right", the paragraph is right-aligned.

leftMargin:Number [optional] - Indicates the left margin of the paragraph, in points.

rightMargin:Number [optional] - Indicates the right margin of the paragraph, in points.

indent:Number [optional] - An integer that indicates the indentation from the left margin to the first character in the paragraph.

leading:Number [optional] - A number that indicates the amount of leading vertical space between lines.

Example

The following example creates a TextFormat object, formats the stats_txt text field, and creates a new text field to display the text in:

// Define a TextFormat which is used to format the stats_txt text field.
var my_fmt:TextFormat = new TextFormat();
my_fmt.bold = true;
my_fmt.font = "Arial";
my_fmt.size = 12;
my_fmt.color = 0xFF0000;
// Create a text field to display the player's statistics.
this.createTextField("stats_txt", 5000, 10, 0, 530, 22);
// Apply the TextFormat to the text field.
stats_txt.setNewTextFormat(my_fmt);
stats_txt.selectable = false;
stats_txt.text = "Lorem ipsum dolor sit amet...";

To view another example, see the animations.fla file in the ActionScript samples Folder. The following list provides typical paths to the ActionScript samples Folder: