flashx.textLayout.formats

# TextLayoutFormat - AS3

Package | flashx.textLayout.formats
Class | public class TextLayoutFormat
Inheritance | TextLayoutFormat Object
Implements | ITextLayoutFormat
Subclasses | ListMarkerFormat

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The TextLayoutFormat class holds all of the text layout properties. These properties affect the format and style of a text flow at the container level, paragraph level, and text level. Both the ContainerController class and the FlowElement base class have `format` properties that enable you to assign a TextLayoutFormat instance to them. Assign a TextLayoutFormat object to a container to affect the format of all of the container's content. Assign a TextLayoutFormat object to a FlowElement descendant to specify formatting for that particular element: TextFlow, ParagraphElement, DivElement, SpanElement, InlineGraphicElement, LinkElement, and TCYElement. In addition to the `format` property, these classes also define each of the individual TextLayoutFormat properties so that you can override the setting of a particular style property for that element, if you wish.

Because you can set a given style at multiple levels, it is possible to have conflicts. For example, the color of the text at the TextFlow level could be set to black while a SpanElement object sets it to blue. The general rule is that the setting at the lowest level on the text flow tree takes precedence. So if the ligature level is set for a TextFlow instance and also set for a DivElement, the DivElement setting takes precedence.

Cascading styles refers to the process of adopting styles from a higher level in the text flow if a style value is undefined at a lower level. When a style is undefined on an element at the point it is about to be rendered, it either takes its default value or the value cascades or descends from the value on a parent element. For example, if the transparency (`textAlpha` property) of the text is undefined on a SpanElement object, but is set on the TextFlow, the value of the `TextFlow.textAlpha` property cascades to the SpanElement object and is applied to the text for that span. The result of the cascade, or the sum of the styles that is applied to the element, is stored in the element's `computedFormat` property.

In the same way, you can apply user styles using the `userStyles` property of the ContainerController and FlowElement classes. This property allows you to read or write a dictionary of user styles and apply its settings to a container or a text flow element. The user styles dictionary is an object that consists of stylename-value pairs. Styles specified by the `userStyles` property take precedence over all others.

Most styles that are undefined inherit the value of their immediate parent during a cascade. A small number of styles, however, do not inherit their parent�s value and take on their default values instead.

Style properties that adopt their default values, if undefined, include: `backgroundAlpha`, `backgroundColor`, `columnCount`, `columnGap`, `columnWidth`, `lineBreak`, `paddingBottom`, `paddingLeft`, `paddingRight`, `paddingTop`, `verticalAlign`

.

View the examples

More examples

Styling TLF-based text controls
Applying styles with the TextLayoutFormat class
Assigning formats to a FlowElement with the TextLayoutFormat class

Related API Elements

flashx.textLayout.elements.FlowElement.format
flashx.textLayout.factory.TextFlowTextLineFactory

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alignmentBaseline : * Specifies the baseline to which the dominant baseline aligns. | TextLayoutFormat
|  | backgroundAlpha : * Alpha (transparency) value for the background (adopts default value if undefined during cascade). | TextLayoutFormat
|  | backgroundColor : * Background color of the text (adopts default value if undefined during cascade). | TextLayoutFormat
|  | baselineShift : * Amount to shift the baseline from the dominantBaseline value. | TextLayoutFormat
|  | blockProgression : * Specifies a vertical or horizontal progression of line placement. | TextLayoutFormat
|  | breakOpportunity : * Controls where lines are allowed to break when breaking wrapping text into multiple lines. | TextLayoutFormat
|  | cffHinting : * The type of CFF hinting used for this text. | TextLayoutFormat
|  | clearFloats : * Controls how text wraps around a float. | TextLayoutFormat
|  | color : * Color of the text. | TextLayoutFormat
|  | columnCount : * Number of text columns (adopts default value if undefined during cascade). | TextLayoutFormat
|  | columnGap : * Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). | TextLayoutFormat
|  | columnWidth : * Column width in pixels (adopts default value if undefined during cascade). | TextLayoutFormat
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | coreStyles : Object [read-only] Returns the coreStyles on this TextLayoutFormat. | TextLayoutFormat
|  | defaultFormat : flashx.textLayout.formats:ITextLayoutFormat [static] [read-only] Returns a TextLayoutFormat object with default settings. | TextLayoutFormat
|  | digitCase : * The type of digit case used for this text. | TextLayoutFormat
|  | digitWidth : * Type of digit width used for this text. | TextLayoutFormat
|  | direction : * Specifies the default bidirectional embedding level of the text in the text block. | TextLayoutFormat
|  | dominantBaseline : * Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. | TextLayoutFormat
|  | firstBaselineOffset : * Specifies the baseline position of the first line in the container. | TextLayoutFormat
|  | fontFamily : * The name of the font to use, or a comma-separated list of font names. | TextLayoutFormat
|  | fontLookup : * Font lookup to use. | TextLayoutFormat
|  | fontSize : * The size of the text in pixels. | TextLayoutFormat
|  | fontStyle : * Style of text. | TextLayoutFormat
|  | fontWeight : * Weight of text. | TextLayoutFormat
|  | justificationRule : * Rule used to justify text in a paragraph. | TextLayoutFormat
|  | justificationStyle : * The style used for justification of the paragraph. | TextLayoutFormat
|  | kerning : * Kerning adjusts the pixels between certain character pairs to improve readability. | TextLayoutFormat
|  | leadingModel : * Specifies the leading model, which is a combination of leading basis and leading direction. | TextLayoutFormat
|  | ligatureLevel : * Controls which of the ligatures that are defined in the font may be used in the text. | TextLayoutFormat
|  | lineBreak : * Controls word wrapping within the container (adopts default value if undefined during cascade). | TextLayoutFormat
|  | lineHeight : * Leading controls for the text. | TextLayoutFormat
|  | lineThrough : * If true, applies strikethrough, a line drawn through the middle of the text. | TextLayoutFormat
|  | linkActiveFormat : * Defines the formatting attributes used for links in normal state. | TextLayoutFormat
|  | linkHoverFormat : * Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. | TextLayoutFormat
|  | linkNormalFormat : * Defines the formatting attributes used for links in normal state. | TextLayoutFormat
|  | listAutoPadding : * This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto. | TextLayoutFormat
|  | listMarkerFormat : * Defines the formatting attributes list markers. | TextLayoutFormat
|  | listStylePosition : * Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade, this property inherits its value from an ancestor. | TextLayoutFormat
|  | listStyleType : * Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade, this property inherits its value from an ancestor. | TextLayoutFormat
|  | locale : * The locale of the text. | TextLayoutFormat
|  | paddingBottom : * Bottom inset in pixels. | TextLayoutFormat
|  | paddingLeft : * Left inset in pixels. | TextLayoutFormat
|  | paddingRight : * Right inset in pixels. | TextLayoutFormat
|  | paddingTop : * Top inset in pixels. | TextLayoutFormat
|  | paragraphEndIndent : * A Number that specifies, in pixels, the amount to indent the paragraph's end edge. | TextLayoutFormat
|  | paragraphSpaceAfter : * A Number that specifies the amount of space, in pixels, to leave after the paragraph. | TextLayoutFormat
|  | paragraphSpaceBefore : * A Number that specifies the amount of space, in pixels, to leave before the paragraph. | TextLayoutFormat
|  | paragraphStartIndent : * A Number that specifies, in pixels, the amount to indent the paragraph's start edge. | TextLayoutFormat
|  | renderingMode : * The rendering mode used for this text. | TextLayoutFormat
|  | styleName : * Assigns an identifying class to the element, making it possible to set a style for the element by referencing the styleName. | TextLayoutFormat
|  | styles : Object [read-only] Returns the styles on this TextLayoutFormat. | TextLayoutFormat
|  | tabStops : * Specifies the tab stops associated with the paragraph. | TextLayoutFormat
|  | textAlign : * Alignment of lines in the paragraph relative to the container. | TextLayoutFormat
|  | textAlignLast : * Alignment of the last (or only) line in the paragraph relative to the container in justified text. | TextLayoutFormat
|  | textAlpha : * Alpha (transparency) value for the text. | TextLayoutFormat
|  | textDecoration : * Decoration on text. | TextLayoutFormat
|  | textIndent : * A Number that specifies, in pixels, the amount to indent the first line of the paragraph. | TextLayoutFormat
|  | textJustify : * Specifies options for justifying text. | TextLayoutFormat
|  | textRotation : * Determines the number of degrees to rotate this text. | TextLayoutFormat
|  | trackingLeft : * Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. | TextLayoutFormat
|  | trackingRight : * Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. | TextLayoutFormat
|  | typographicCase : * The type of typographic case used for this text. | TextLayoutFormat
|  | userStyles : Object [read-only] Returns the userStyles on this TextLayoutFormat. | TextLayoutFormat
|  | verticalAlign : * Vertical alignment or justification (adopts default value if undefined during cascade). | TextLayoutFormat
|  | whiteSpaceCollapse : * Collapses or preserves whitespace when importing text into a TextFlow. | TextLayoutFormat
|  | wordSpacing : * Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. | TextLayoutFormat

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TextLayoutFormat(initialValues:flashx.textLayout.formats:ITextLayoutFormat = null) Creates a new TextLayoutFormat object. | TextLayoutFormat
|  | apply(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Replaces property values in this TextLayoutFormat object with the values of properties that are set in the incoming ITextLayoutFormat instance. | TextLayoutFormat
|  | concat(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Concatenates the values of properties in the incoming ITextLayoutFormat instance with the values of this TextLayoutFormat object. | TextLayoutFormat
|  | concatInheritOnly(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Concatenates the values of properties in the incoming ITextLayoutFormat instance with the values of this TextLayoutFormat object. | TextLayoutFormat
|  | copy(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Copies TextLayoutFormat settings from the values ITextLayoutFormat instance into this TextLayoutFormat object. | TextLayoutFormat
|  | createTextLayoutFormat(initialValues:Object):flashx.textLayout.formats:TextLayoutFormat [static] Creates a new TextLayoutFormat object. | TextLayoutFormat
|  | getStyle(styleProp:String):* Returns the value of the style specified by the styleProp parameter, which specifies the style name. | TextLayoutFormat
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isEqual(p1:flashx.textLayout.formats:ITextLayoutFormat, p2:flashx.textLayout.formats:ITextLayoutFormat):Boolean [static] Compares properties in ITextLayoutFormat instance p1 with properties in ITextLayoutFormat instance p2 and returns true if all properties match. | TextLayoutFormat
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeClashing(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Sets properties in this TextLayoutFormat object to undefined if they do not match those in the incoming ITextLayoutFormat instance. | TextLayoutFormat
|  | removeMatching(incoming:flashx.textLayout.formats:ITextLayoutFormat):void Sets properties in this TextLayoutFormat object to undefined if they match those in the incoming ITextLayoutFormat instance. | TextLayoutFormat
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | setStyle(styleProp:String, newValue:*):void Sets the style specified by the styleProp parameter to the value specified by the newValue parameter. | TextLayoutFormat
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### alignmentBaseline

property

`alignmentBaseline:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the baseline to which the dominant baseline aligns. For example, if you set `dominantBaseline` to ASCENT, setting `alignmentBaseline` to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.

Legal values are TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, TextBaseline.USE_DOMINANT_BASELINE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextBaseline.USE_DOMINANT_BASELINE.

Implementation
`public function get alignmentBaseline():*`
`public function set alignmentBaseline(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.TextBaseline
Example ( How to use this example )
This example sets `alignmentBaseline` to three different values - USE_DOMINANT_BASELINE, DESCENT, and IDEOGRAPHIC_CENTER - for three spans in a paragraph that has `dominantBaseline` set to ASCENT.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flash.text.engine.TextBaseline;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextAlign;

        public class TextLayoutFormat_alignmentBaselineExample extends Sprite
        {
            public function TextLayoutFormat_alignmentBaselineExample()
            {
                // create text flow with dominantBaseline of ASCENT and 3 spans
                var textFlow:TextFlow = new TextFlow();
                var paragraph:ParagraphElement = new ParagraphElement();
                paragraph.fontFamily = "Helvetica";
                paragraph.fontSize = 20;
                paragraph.dominantBaseline = TextBaseline.ASCENT
                var spanOne:SpanElement = new SpanElement();
                var spanTwo:SpanElement = new SpanElement();
                var spanThree:SpanElement = new SpanElement();
                spanOne.text = "Hello, World  ";
                spanTwo.text = "Hello, World  ";
                spanThree.text = "Hello, World";

                // add spans to paragraph and specify alignment baseline for each
                paragraph.addChild(spanOne);
                spanOne.alignmentBaseline = TextBaseline.USE_DOMINANT_BASELINE;
                paragraph.addChild(spanTwo);
                spanTwo.alignmentBaseline = TextBaseline.DESCENT;
                paragraph.addChild(spanThree);
                spanThree.alignmentBaseline = TextBaseline.IDEOGRAPHIC_CENTER;

                // add paragraph to TextFlow and set container position
                textFlow.addChild(paragraph);
                this.x = 50;
                this.y = 100;

                // update controller to display on stage
                textFlow.flowComposer.addController(new ContainerController(this,400,300));
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### backgroundAlpha

property

`backgroundAlpha:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Alpha (transparency) value for the background (adopts default value if undefined during cascade). A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with alpha set to 0 are active, even though they are invisible.

Legal values are numbers from 0 to 1 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 1.

Implementation
`public function get backgroundAlpha():*`
`public function set backgroundAlpha(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### backgroundColor

property

`backgroundColor:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Background color of the text (adopts default value if undefined during cascade). Can be either the constant value `BackgroundColor.TRANSPARENT`, or a hexadecimal value that specifies the three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.

Legal values as a string are BackgroundColor.TRANSPARENT, FormatValue.INHERIT and uints from 0x0 to 0xffffffff.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of BackgroundColor.TRANSPARENT.

Implementation
`public function get backgroundColor():*`
`public function set backgroundColor(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.BackgroundColor

### baselineShift

property

`baselineShift:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Amount to shift the baseline from the `dominantBaseline` value. Units are in pixels, or a percentage of `fontSize` (in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical).

Legal values are BaselineShift.SUPERSCRIPT, BaselineShift.SUBSCRIPT, FormatValue.INHERIT.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are numbers from -1000 to 1000.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0.

Implementation
`public function get baselineShift():*`
`public function set baselineShift(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.BaselineShift

### blockProgression

property

`blockProgression:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies a vertical or horizontal progression of line placement. Lines are either placed top-to-bottom (`BlockProgression.TB`, used for horizontal text) or right-to-left (`BlockProgression.RL`, used for vertical text).

Legal values are BlockProgression.RL, BlockProgression.TB, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of BlockProgression.TB.

Implementation
`public function get blockProgression():*`
`public function set blockProgression(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.BlockProgression

### breakOpportunity

property

`breakOpportunity:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Controls where lines are allowed to break when breaking wrapping text into multiple lines. Set to `BreakOpportunity.AUTO` to break text normally. Set to `BreakOpportunity.NONE` to not break the text unless the text would overrun the measure and there are no other places to break the line. Set to `BreakOpportunity.ANY` to allow the line to break anywhere, rather than just between words. Set to `BreakOpportunity.ALL` to have each typographic cluster put on a separate line (useful for text on a path).

Legal values are BreakOpportunity.ALL, BreakOpportunity.ANY, BreakOpportunity.AUTO, BreakOpportunity.NONE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of BreakOpportunity.AUTO.

Implementation
`public function get breakOpportunity():*`
`public function set breakOpportunity(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.BreakOpportunity

### cffHinting

property

`cffHinting:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the `renderingMode` property is set to `RenderingMode.CFF`, and the font is embedded (`fontLookup` property is set to `FontLookup.EMBEDDED_CFF`). At small screen sizes, hinting produces a clear, legible text for human readers.

Legal values are CFFHinting.NONE, CFFHinting.HORIZONTAL_STEM, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFFHinting.HORIZONTAL_STEM.

Implementation
`public function get cffHinting():*`
`public function set cffHinting(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.CFFHinting

### clearFloats

property

`clearFloats:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Controls how text wraps around a float. A value of "none" allows the text to wrap most closely around a float. A value of "left" causes the text to skip over any portion of the container that has a left float. A value of "right" causes the text to skip over any portion of the container that has a right float. A value of "both" causes the text to skip over any floats.

Legal values are `ClearFloats.START`, `ClearFloats.END`, `ClearFloats.LEFT`, `ClearFloats.RIGHT`, `ClearFloats.BOTH`, `ClearFloats.NONE`, and `FormatValue.INHERIT`.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of `ClearFloats.NONE`.

Implementation
`public function get clearFloats():*`
`public function set clearFloats(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

Related API Elements

flashx.textLayout.formats.ClearFloats

### color

property

`color:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get color():*`
`public function set color(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### columnCount

property

`columnCount:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Number of text columns (adopts default value if undefined during cascade). The column number overrides the other column settings. Value is an integer, or `FormatValue.AUTO` if unspecified. If `columnCount` is not specified,`columnWidth` is used to create as many columns as can fit in the container.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and from ints from 1 to 50.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get columnCount():*`
`public function set columnCount(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.FormatValue

### columnGap

property

`columnGap:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). Value is a Number

Legal values are numbers from 0 to 1000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of 20.

Implementation
`public function get columnGap():*`
`public function set columnGap(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### columnWidth

property

`columnWidth:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Column width in pixels (adopts default value if undefined during cascade). If you specify the width of the columns, but not the count, TextLayout will create as many columns of that width as possible, given the container width and `columnGap` settings. Any remainder space is left after the last column. Value is a Number.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from 0 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get columnWidth():*`
`public function set columnWidth(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.FormatValue

### coreStyles

property

`coreStyles:Object` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the `coreStyles` on this TextLayoutFormat. The coreStyles object includes the formats that are defined by TextLayoutFormat and are in TextLayoutFormat.description. The returned `coreStyles` object consists of an array of stylename-value pairs.

Implementation
`public function get coreStyles():Object`

Related API Elements

flashx.textLayout.formats.TextLayoutFormat

### defaultFormat

property

`defaultFormat:flashx.textLayout.formats:ITextLayoutFormat` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns a TextLayoutFormat object with default settings. This method always returns the same object.

Implementation
`public static function get defaultFormat():flashx.textLayout.formats:ITextLayoutFormat`

### digitCase

property

`digitCase:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The type of digit case used for this text. Setting the value to `DigitCase.OLD_STYLE` approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The `DigitCase.LINING` setting has all-cap height and is typically monospaced to line up in charts.

Legal values are DigitCase.DEFAULT, DigitCase.LINING, DigitCase.OLD_STYLE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitCase.DEFAULT.

Implementation
`public function get digitCase():*`
`public function set digitCase(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.DigitCase

### digitWidth

property

`digitWidth:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Type of digit width used for this text. This can be `DigitWidth.PROPORTIONAL`, which looks best for individual numbers, or `DigitWidth.TABULAR`, which works best for numbers in tables, charts, and vertical rows.

Legal values are DigitWidth.DEFAULT, DigitWidth.PROPORTIONAL, DigitWidth.TABULAR, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DigitWidth.DEFAULT.

Implementation
`public function get digitWidth():*`
`public function set digitWidth(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.DigitWidth

### direction

property

`direction:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the default bidirectional embedding level of the text in the text block. Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples:

Legal values are Direction.LTR, Direction.RTL, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of Direction.LTR.

Implementation
`public function get direction():*`
`public function set direction(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.Direction

### dominantBaseline

property

`dominantBaseline:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies which element baseline snaps to the `alignmentBaseline` to determine the vertical position of the element on the line. A value of `TextBaseline.AUTO` selects the dominant baseline based on the `locale` property of the parent paragraph. For Japanese and Chinese, the selected baseline value is `TextBaseline.IDEOGRAPHIC_CENTER`; for all others it is `TextBaseline.ROMAN`. These baseline choices are determined by the choice of font and the font size.

Legal values are FormatValue.AUTO, TextBaseline.ROMAN, TextBaseline.ASCENT, TextBaseline.DESCENT, TextBaseline.IDEOGRAPHIC_TOP, TextBaseline.IDEOGRAPHIC_CENTER, TextBaseline.IDEOGRAPHIC_BOTTOM, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.

Implementation
`public function get dominantBaseline():*`
`public function set dominantBaseline(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.TextBaseline

### firstBaselineOffset

property

`firstBaselineOffset:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the baseline position of the first line in the container. Which baseline this property refers to depends on the container-level locale. For Japanese and Chinese, it is `TextBaseline.IDEOGRAPHIC_BOTTOM`; for all others it is `TextBaseline.ROMAN`. The offset from the top inset (or right inset if `blockProgression` is RL) of the container to the baseline of the first line can be either `BaselineOffset.ASCENT`, meaning equal to the ascent of the line, `BaselineOffset.LINE_HEIGHT`, meaning equal to the height of that first line, or any fixed-value number to specify an absolute distance. `BaselineOffset.AUTO` aligns the ascent of the line with the container top inset.

Legal values as a string are BaselineOffset.AUTO, BaselineOffset.ASCENT, BaselineOffset.LINE_HEIGHT, FormatValue.INHERIT and numbers from 0 to 1000.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of BaselineOffset.AUTO.

Implementation
`public function get firstBaselineOffset():*`
`public function set firstBaselineOffset(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.BaselineOffset

### fontFamily

property

`fontFamily:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Arial.

Implementation
`public function get fontFamily():*`
`public function set fontFamily(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### fontLookup

property

`fontLookup:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Font lookup to use. Specifying `FontLookup.DEVICE` uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying `FontLookup.EMBEDDED_CFF` uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font.

Legal values are FontLookup.DEVICE, FontLookup.EMBEDDED_CFF, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontLookup.DEVICE.

Implementation
`public function get fontLookup():*`
`public function set fontLookup(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.FontLookup

### fontSize

property

`fontSize:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The size of the text in pixels.

Legal values are numbers from 1 to 720 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12.

Implementation
`public function get fontSize():*`
`public function set fontSize(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### fontStyle

property

`fontStyle:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Style of text. May be `FontPosture.NORMAL`, for use in plain text, or `FontPosture.ITALIC` for italic. This property applies only to device fonts (`fontLookup` property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are FontPosture.NORMAL, FontPosture.ITALIC, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontPosture.NORMAL.

Implementation
`public function get fontStyle():*`
`public function set fontStyle(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.FontPosture

### fontWeight

property

`fontWeight:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Weight of text. May be `FontWeight.NORMAL` for use in plain text, or `FontWeight.BOLD`. Applies only to device fonts (`fontLookup` property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are FontWeight.NORMAL, FontWeight.BOLD, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of FontWeight.NORMAL.

Implementation
`public function get fontWeight():*`
`public function set fontWeight(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.FontWeight

### justificationRule

property

`justificationRule:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Rule used to justify text in a paragraph. Default value is `FormatValue.AUTO`, which justifies text based on the paragraph's `locale` property. For all languages except Japanese and Chinese, `FormatValue.AUTO` becomes `JustificationRule.SPACE`, which adds extra space to the space characters. For Japanese and Chinese, `FormatValue.AUTO` becomes `JustficationRule.EAST_ASIAN`. In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.

Legal values are JustificationRule.EAST_ASIAN, JustificationRule.SPACE, FormatValue.AUTO, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.

Implementation
`public function get justificationRule():*`
`public function set justificationRule(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.JustificationRule

### justificationStyle

property

`justificationStyle:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The style used for justification of the paragraph. Used only in conjunction with a `justificationRule` setting of `JustificationRule.EAST_ASIAN`. Default value of `FormatValue.AUTO` is resolved to `JustificationStyle.PUSH_IN_KINSOKU` for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify `JustificationStyle.PUSH-OUT-ONLY`. If you want behavior that is like what you get with the `justificationRule` of `JustificationRule.SPACE`, use `JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT`.

Legal values are JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, JustificationStyle.PUSH_IN_KINSOKU, JustificationStyle.PUSH_OUT_ONLY, FormatValue.AUTO, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of FormatValue.AUTO.

Implementation
`public function get justificationStyle():*`
`public function set justificationStyle(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.JustificationStyle

### kerning

property

`kerning:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.

Legal values are Kerning.ON, Kerning.OFF, Kerning.AUTO, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Kerning.AUTO.

Implementation
`public function get kerning():*`
`public function set kerning(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.Kerning

### leadingModel

property

`leadingModel:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the leading model, which is a combination of leading basis and leading direction. Leading basis is the baseline to which the `lineHeight` property refers. Leading direction determines whether the `lineHeight` property refers to the distance of a line's baseline from that of the line before it or the line after it. The default value of `FormatValue.AUTO` is resolved based on the paragraph's `locale` property. For Japanese and Chinese, it is `LeadingModel.IDEOGRAPHIC_TOP_DOWN` and for all others it is `LeadingModel.ROMAN_UP`.

Leading Basis:

Leading Direction:

Legal values are LeadingModel.ROMAN_UP, LeadingModel.IDEOGRAPHIC_TOP_UP, LeadingModel.IDEOGRAPHIC_CENTER_UP, LeadingModel.IDEOGRAPHIC_TOP_DOWN, LeadingModel.IDEOGRAPHIC_CENTER_DOWN, LeadingModel.APPROXIMATE_TEXT_FIELD, LeadingModel.ASCENT_DESCENT_UP, LeadingModel.BOX, LeadingModel.AUTO, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of LeadingModel.AUTO.

Implementation
`public function get leadingModel():*`
`public function set leadingModel(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.LeadingModel

### ligatureLevel

property

`ligatureLevel:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - `MINIMUM`, `COMMON`, `UNCOMMON`, and `EXOTIC` - are additive. Each value enables a new set of ligatures, but also includes those of the previous types.

Note: When working with Arabic or Syriac fonts, `ligatureLevel` must be set to MINIMUM or above.

Legal values are LigatureLevel.MINIMUM, LigatureLevel.COMMON, LigatureLevel.UNCOMMON, LigatureLevel.EXOTIC, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LigatureLevel.COMMON.

Implementation
`public function get ligatureLevel():*`
`public function set ligatureLevel(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.LigatureLevel

### lineBreak

property

`lineBreak:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Controls word wrapping within the container (adopts default value if undefined during cascade). Text in the container may be set to fit the width of the container (`LineBreak.TO_FIT`), or can be set to break only at explicit return or line feed characters (`LineBreak.EXPLICIT`).

Legal values are LineBreak.EXPLICIT, LineBreak.TO_FIT, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of LineBreak.TO_FIT.

Implementation
`public function get lineBreak():*`
`public function set lineBreak(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.LineBreak

### lineHeight

property

`lineHeight:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Leading controls for the text. The distance from the baseline of the previous or the next line (based on `LeadingModel`) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.

Legal values as a number are from -720 to 720.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%.

Implementation
`public function get lineHeight():*`
`public function set lineHeight(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### lineThrough

property

`lineThrough:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

If `true`, applies strikethrough, a line drawn through the middle of the text.

Legal values are true, false and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false.

Implementation
`public function get lineThrough():*`
`public function set lineThrough(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### linkActiveFormat

property

`linkActiveFormat:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants. Accepts `inherit`, an `ITextLayoutFormat` or converts an array of objects with key and value as members to a TextLayoutFormat.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of null.

Implementation
`public function get linkActiveFormat():*`
`public function set linkActiveFormat(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

### linkHoverFormat

property

`linkHoverFormat:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Defines the formatting attributes used for links in hover state, when the mouse is within the bounds (rolling over) a link. This value will cascade down the hierarchy and apply to any links that are descendants. Accepts `inherit`, an `ITextLayoutFormat` or converts an array of objects with key and value as members to a TextLayoutFormat.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.

Implementation
`public function get linkHoverFormat():*`
`public function set linkHoverFormat(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

### linkNormalFormat

property

`linkNormalFormat:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Defines the formatting attributes used for links in normal state. This value will cascade down the hierarchy and apply to any links that are descendants. Accepts `inherit`, an `ITextLayoutFormat` or converts an array of objects with key and value as members to a TextLayoutFormat.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of null.

Implementation
`public function get linkNormalFormat():*`
`public function set linkNormalFormat(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

### listAutoPadding

property

`listAutoPadding:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

This specifies an auto indent for the start edge of lists when the padding value of the list on that side is `auto`.

Legal values are numbers from -1000 to 1000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of 40.

Implementation
`public function get listAutoPadding():*`
`public function set listAutoPadding(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### listMarkerFormat

property

`listMarkerFormat:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Defines the formatting attributes list markers. This value will cascade down the hierarchy and apply to any links that are descendants. Accepts `inherit`, an `IListMarkerFormat` or converts an array of objects with key and value as members to a ListMarkerFormat.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of null.

Implementation
`public function get listMarkerFormat():*`
`public function set listMarkerFormat(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

### listStylePosition

property

`listStylePosition:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Legal values are ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of ListStylePosition.OUTSIDE.

Implementation
`public function get listStylePosition():*`
`public function set listStylePosition(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.ListStylePosition

### listStyleType

property

`listStyleType:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Legal values are ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of ListStyleType.DISC.

Implementation
`public function get listStyleType():*`
`public function set listStyleType(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.ListStyleType

### locale

property

`locale:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en.

Implementation
`public function get locale():*`
`public function set locale(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### paddingBottom

property

`paddingBottom:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Bottom inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the bottom edge of the container and the text. Value is a Number or auto.

With horizontal text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the bottom of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get paddingBottom():*`
`public function set paddingBottom(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.elements.Configuration.autoListElementStartPadding
flashx.textLayout.formats.FormatValue

### paddingLeft

property

`paddingLeft:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Left inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the left edge of the container and the text. Value is a Number or auto.

With vertical text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the end of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get paddingLeft():*`
`public function set paddingLeft(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.elements.Configuration.autoListElementStartPadding
flashx.textLayout.formats.FormatValue

### paddingRight

property

`paddingRight:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Right inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the right edge of the container and the text. Value is a Number or auto.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get paddingRight():*`
`public function set paddingRight(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.elements.Configuration.autoListElementStartPadding
flashx.textLayout.formats.FormatValue

### paddingTop

property

`paddingTop:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Top inset in pixels. Default of auto is zero except in lists which get a start side padding of 45. (adopts default value if undefined during cascade). Space between the top edge of the container and the text. Value is a Number or auto.

Legal values as a string are FormatValue.AUTO, FormatValue.INHERIT and numbers from -8000 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of FormatValue.AUTO.

Implementation
`public function get paddingTop():*`
`public function set paddingTop(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.elements.Configuration.autoListElementStartPadding
flashx.textLayout.formats.FormatValue

### paragraphEndIndent

property

`paragraphEndIndent:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A Number that specifies, in pixels, the amount to indent the paragraph's end edge. Refers to the right edge in left-to-right text and the left edge in right-to-left text.

Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get paragraphEndIndent():*`
`public function set paragraphEndIndent(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### paragraphSpaceAfter

property

`paragraphSpaceAfter:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A Number that specifies the amount of space, in pixels, to leave after the paragraph. Collapses in tandem with `paragraphSpaceBefore`.

Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get paragraphSpaceAfter():*`
`public function set paragraphSpaceAfter(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### paragraphSpaceBefore

property

`paragraphSpaceBefore:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A Number that specifies the amount of space, in pixels, to leave before the paragraph. Collapses in tandem with `paragraphSpaceAfter`.

Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get paragraphSpaceBefore():*`
`public function set paragraphSpaceBefore(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### paragraphStartIndent

property

`paragraphStartIndent:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A Number that specifies, in pixels, the amount to indent the paragraph's start edge. Refers to the left edge in left-to-right text and the right edge in right-to-left text.

Legal values are numbers from 0 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get paragraphStartIndent():*`
`public function set paragraphStartIndent(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### renderingMode

property

`renderingMode:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The rendering mode used for this text. Applies only to embedded fonts (`fontLookup` property is set to `FontLookup.EMBEDDED_CFF`).

Legal values are RenderingMode.NORMAL, RenderingMode.CFF, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of RenderingMode.CFF.

Implementation
`public function get renderingMode():*`
`public function set renderingMode(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.RenderingMode

### styleName

property

`styleName:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Assigns an identifying class to the element, making it possible to set a style for the element by referencing the `styleName`.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of null.

Implementation
`public function get styleName():*`
`public function set styleName(value:any):void`
Throws

| `RangeError` — When set value is not within range for this property.

### styles

property

`styles:Object` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the styles on this TextLayoutFormat. Note that the getter makes a copy of the styles dictionary. The coreStyles object encapsulates all styles set in the format property including core and user styles. The returned object consists of an array of stylename-value pairs.

Implementation
`public function get styles():Object`

Related API Elements

flashx.textLayout.formats.TextLayoutFormat

### tabStops

property

`tabStops:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the tab stops associated with the paragraph. Setters can take an array of TabStopFormat, a condensed string representation, undefined, or `FormatValue.INHERIT`. The condensed string representation is always converted into an array of TabStopFormat.

The string-based format is a list of tab stops, where each tab stop is delimited by one or more spaces.

A tab stop takes the following form: <alignment type><alignment position>|<alignment token>.

The alignment type is a single character, and can be S, E, C, or D (or lower-case equivalents). S or s for start, E or e for end, C or c for center, D or d for decimal. The alignment type is optional, and if its not specified will default to S.

The alignment position is a Number, and is specified according to FXG spec for Numbers (decimal or scientific notation). The alignment position is required.

The vertical bar is used to separate the alignment position from the alignment token, and should only be present if the alignment token is present.

The alignment token is optional if the alignment type is D, and should not be present if the alignment type is anything other than D. The alignment token may be any sequence of characters terminated by the space that ends the tab stop (for the last tab stop, the terminating space is optional; end of alignment token is implied). A space may be part of the alignment token if it is escaped with a backslash (\ ). A backslash may be part of the alignment token if it is escaped with another backslash (\\). If the alignment type is D, and the alignment token is not specified, it will take on the default value of null.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of null.

Implementation
`public function get tabStops():*`
`public function set tabStops(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TabStopFormat

### textAlign

property

`textAlign:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Alignment of lines in the paragraph relative to the container. `TextAlign.LEFT` aligns lines along the left edge of the container. `TextAlign.RIGHT` aligns on the right edge. `TextAlign.CENTER` positions the line equidistant from the left and right edges. `TextAlign.JUSTIFY` spreads the lines out so they fill the space. `TextAlign.START` is equivalent to setting left in left-to-right text, or right in right-to-left text. `TextAlign.END` is equivalent to setting right in left-to-right text, or left in right-to-left text.

Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.

Implementation
`public function get textAlign():*`
`public function set textAlign(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TextAlign

### textAlignLast

property

`textAlignLast:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Alignment of the last (or only) line in the paragraph relative to the container in justified text. If `textAlign` is set to `TextAlign.JUSTIFY`, `textAlignLast` specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to `textAlign`.

Legal values are TextAlign.LEFT, TextAlign.RIGHT, TextAlign.CENTER, TextAlign.JUSTIFY, TextAlign.START, TextAlign.END, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextAlign.START.

Implementation
`public function get textAlignLast():*`
`public function set textAlignLast(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TextAlign

### textAlpha

property

`textAlpha:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with `textAlpha` set to 0 are active, even though they are invisible.

Legal values are numbers from 0 to 1 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1.

Implementation
`public function get textAlpha():*`
`public function set textAlpha(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### textDecoration

property

`textDecoration:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Decoration on text. Use to apply underlining; default is none.

Legal values are TextDecoration.NONE, TextDecoration.UNDERLINE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextDecoration.NONE.

Implementation
`public function get textDecoration():*`
`public function set textDecoration(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TextDecoration

### textIndent

property

`textIndent:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

A Number that specifies, in pixels, the amount to indent the first line of the paragraph. A negative indent will push the line into the margin, and possibly out of the container.

Legal values are numbers from -8000 to 8000 and FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get textIndent():*`
`public function set textIndent(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### textJustify

property

`textJustify:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies options for justifying text. Default value is `TextJustify.INTER_WORD`, meaning that extra space is added to the space characters. `TextJustify.DISTRIBUTE` adds extra space to space characters and between individual letters. Used only in conjunction with a `justificationRule` value of `JustificationRule.SPACE`.

Legal values are TextJustify.INTER_WORD, TextJustify.DISTRIBUTE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of TextJustify.INTER_WORD.

Implementation
`public function get textJustify():*`
`public function set textJustify(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TextJustify

### textRotation

property

`textRotation:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Determines the number of degrees to rotate this text.

Legal values are TextRotation.ROTATE_0, TextRotation.ROTATE_180, TextRotation.ROTATE_270, TextRotation.ROTATE_90, TextRotation.AUTO, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TextRotation.AUTO.

Implementation
`public function get textRotation():*`
`public function set textRotation(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flash.text.engine.TextRotation

### trackingLeft

property

`trackingLeft:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Number in pixels (or percent of `fontSize`, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the `trackingLeft` value is added to the values in the kerning table for the font. If kerning is disabled, the `trackingLeft` value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get trackingLeft():*`
`public function set trackingLeft(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### trackingRight

property

`trackingRight:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Number in pixels (or percent of `fontSize`, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the `trackingRight` value is added to the values in the kerning table for the font. If kerning is disabled, the `trackingRight` value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

Implementation
`public function get trackingRight():*`
`public function set trackingRight(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

### typographicCase

property

`typographicCase:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

The type of typographic case used for this text. Here are some examples:

Legal values are TLFTypographicCase.DEFAULT, TLFTypographicCase.CAPS_TO_SMALL_CAPS, TLFTypographicCase.UPPERCASE, TLFTypographicCase.LOWERCASE, TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TLFTypographicCase.DEFAULT.

Implementation
`public function get typographicCase():*`
`public function set typographicCase(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.TLFTypographicCase

### userStyles

property

`userStyles:Object` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the `userStyles` on this TextLayoutFormat. The userStyles object includes the formats that are defined by TextLayoutFormat and are not in TextLayoutFormat.description. The returned `userStyles` object consists of an array of stylename-value pairs.

Implementation
`public function get userStyles():Object`

Related API Elements

flashx.textLayout.formats.TextLayoutFormat

### verticalAlign

property

`verticalAlign:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Vertical alignment or justification (adopts default value if undefined during cascade). Determines how TextFlow elements align within the container.

Legal values are VerticalAlign.TOP, VerticalAlign.MIDDLE, VerticalAlign.BOTTOM, VerticalAlign.JUSTIFY, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property has a value of VerticalAlign.TOP.

Implementation
`public function get verticalAlign():*`
`public function set verticalAlign(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.VerticalAlign

### whiteSpaceCollapse

property

`whiteSpaceCollapse:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Collapses or preserves whitespace when importing text into a TextFlow. `WhiteSpaceCollapse.PRESERVE` retains all whitespace characters. `WhiteSpaceCollapse.COLLAPSE` removes newlines, tabs, and leading or trailing spaces within a block of imported text. Line break tags () and Unicode line separator characters are retained.

Legal values are WhiteSpaceCollapse.PRESERVE, WhiteSpaceCollapse.COLLAPSE, FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of WhiteSpaceCollapse.COLLAPSE.

Implementation
`public function get whiteSpaceCollapse():*`
`public function set whiteSpaceCollapse(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Related API Elements

flashx.textLayout.formats.WhiteSpaceCollapse

### wordSpacing

property

`wordSpacing:*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the optimum, minimum, and maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. The optimum space is used to indicate the desired size of a space, as a fraction of the value defined in the font. The minimum and maximum values are the used when textJustify is distribute to determine how wide or narrow the spaces between the words may grow before letter spacing is used to justify the line.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade, this property inherits its value from an ancestor. If no ancestor has set this property, it will have a value of 100%, 50%, 150%.

Implementation
`public function get wordSpacing():*`
`public function set wordSpacing(value:any):void`
Throws

| `RangeError` — when set value is not within range for this property

Constructor Detail

### TextLayoutFormat

()
Constructor

`public function TextLayoutFormat(initialValues:flashx.textLayout.formats:ITextLayoutFormat = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Creates a new TextLayoutFormat object. All settings are empty or, optionally, are initialized from the supplied `initialValues` object.

Parameters

| `initialValues:flashx.textLayout.formats:ITextLayoutFormat` (default = `null`)`` — optional instance from which to copy initial values.

Related API Elements

defaultFormat
Method Detail

### apply

()
method

`public function apply(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Replaces property values in this TextLayoutFormat object with the values of properties that are set in the `incoming` ITextLayoutFormat instance. Properties that are `undefined` in the `incoming` ITextLayoutFormat instance are not changed in this object.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — instance whose property values are applied to this TextLayoutFormat object.

Example ( How to use this example )
This example applies the settings in one TextLayoutFormat object to a second one (textFormatLayout) and uses the receiving object to format the text.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_applyExample extends Sprite
        {
            public function TextLayoutFormat_applyExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes in the first one
                textLayoutFormat.textIndent = 8;
                textLayoutFormat.color = 0x336633;
                textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
                textLayoutFormat.fontSize = 24;
                // set some of the same attributes on the second one
                textLayoutFormat2.color = 0x0000CC;
                textLayoutFormat2.fontSize = 12;
                textLayoutFormat2.textIndent = 24;
                // add text to the span, the span to the paragraph, and the paragraph to the text flow.
                span.text = "Notice that fontFamily is unchanged because it was undefined in textLayoutFormat2.";
                p.addChild( span);
                textFlow.addChild(p);
                // use apply() to apply textLayoutFormat2 format settings; assign format to the text flow
                textLayoutFormat.apply(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add paragraph to textFlow and update controller to display it
                textFlow.addChild(p);
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### concat

()
method

`public function concat(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Concatenates the values of properties in the `incoming` ITextLayoutFormat instance with the values of this TextLayoutFormat object. In this (the receiving) TextLayoutFormat object, properties whose values are `FormatValue.INHERIT`, and inheriting properties whose values are `undefined` will get new values from the `incoming` object. Non-inheriting properties whose values are `undefined` will get their default values. All other property values will remain unmodified.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — instance from which values are concatenated.

Related API Elements

flashx.textLayout.formats.FormatValue.INHERIT
Example ( How to use this example )
This example adds values that are set in one TextLayoutFormat object to corresponding properties whose values are undefined in a second object (textFormatLayout) and uses the receiving object to format the text.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_concatExample extends Sprite
        {
            public function TextLayoutFormat_concatExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes in the first one
                textLayoutFormat.textIndent = 8;
                textLayoutFormat.color = 0x336633;
                textLayoutFormat.fontSize = 18;
                // set some of the same attributes on the second one
                textLayoutFormat2.textIndent = 24;
                textLayoutFormat2.color = 0x0000CC;
                textLayoutFormat2.fontSize = 12;
                textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";
                // concat textLayoutFormat2 settings; assign format to the text flow
                textLayoutFormat.concat(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add text to the span, the span to the paragraph, and the paragraph to the text flow.
                span.text = "Notice that fontFamily value has been added from textLayout2 to textLayout but " +
                    "the other values have not been changed.";
                p.addChild( span);
                textFlow.addChild(p);
                // update controller to display it
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### concatInheritOnly

()
method

`public function concatInheritOnly(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Concatenates the values of properties in the `incoming` ITextLayoutFormat instance with the values of this TextLayoutFormat object. In this (the receiving) TextLayoutFormat object, properties whose values are `FormatValue.INHERIT`, and inheriting properties whose values are `undefined` will get new values from the `incoming` object. All other property values will remain unmodified.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — instance from which values are concatenated.

Related API Elements

flashx.textLayout.formats.FormatValue.INHERIT
Example ( How to use this example )
This example adds values of one TextLayoutFormat object to corresponding properties whose values are undefined in a second TextLayoutFormat object, but only if the property can inherit. The example formats the text with the result in the receiving TextLayoutFormat object.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_concatInheritOnlyExample extends Sprite
        {
            public function TextLayoutFormat_concatInheritOnlyExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes in the first one
                textLayoutFormat.color = 0xFF0000;
                textLayoutFormat.fontSize = undefined;
                // set attributes on the second one (fontSize set here, too)
                textLayoutFormat2.color = 0x00FF00;
                textLayoutFormat2.backgroundColor = 0x00CCCC;
                textLayoutFormat2.fontSize = 16;
                textLayoutFormat2.fontFamily = "Times Roman";
                // concat textLayoutFormat2 settings; assign format to the text flow
                textLayoutFormat.concatInheritOnly(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add text to the span, the span to the paragraph, and the paragraph to the text flow.
                span.text = "Notice that the value of backgroundColor is "
                span.text += textLayoutFormat.backgroundColor;
                span.text += ", even though it is set in textLayoutFormat2. This is because " +
                    "this property does not inherit. Also notice that font color does not change " +
                    "because it is not undefined."
                p.addChild( span);
                textFlow.addChild(p);
                // update controller to display it
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### copy

()
method

`public function copy(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Copies TextLayoutFormat settings from the `values` ITextLayoutFormat instance into this TextLayoutFormat object. If `values` is `null`, this TextLayoutFormat object is initialized with undefined values for all properties.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — optional instance from which to copy values.

Example ( How to use this example )
This example uses copy() to override the default format settings in one TextLayoutFormat object with a TextLayoutFormat object that has some formatting properties set.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_copyExample extends Sprite
        {
            public function TextLayoutFormat_copyExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes in the second one
                textLayoutFormat2.textIndent = 8;
                textLayoutFormat2.color = 0x336633;
                textLayoutFormat2.fontFamily = "Times Roman";
                textLayoutFormat2.fontSize = 18;
                // add text to the span, the span to the paragraph, and the paragraph to the text flow.
                span.text = "Notice that formatting values set in textLayoutFormat2 override " +
                    "the default values in textLayoutFormat.";
                p.addChild(span);
                textFlow.addChild(p);
                // copy format settings of textLayoutFormat2; assign format to the text flow
                textLayoutFormat.copy(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add paragraph to textFlow and update controller to display it
                textFlow.addChild(p);
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### createTextLayoutFormat

()
method

`public static function createTextLayoutFormat(initialValues:Object):flashx.textLayout.formats:TextLayoutFormat`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Creates a new TextLayoutFormat object. All settings are empty or, optionally, are initialized from the supplied `initialValues` object.

Parameters

| `initialValues:Object` — Optional instance from which to copy initial values, if an ITextLayoutFormat object's values are copied. Otherwise this parameter is treated like a Dictionary or Object and iterated over.

Returns

| `flashx.textLayout.formats:TextLayoutFormat`

### getStyle

()
method

`public function getStyle(styleProp:String):*`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the value of the style specified by the `styleProp` parameter, which specifies the style name.

Parameters

| `styleProp:String` — The name of the style whose value is to be retrieved.

Returns

| `*` — The value of the specified style. The type varies depending on the type of the style being accessed. Returns `undefined` if the style is not set.

### isEqual

()
method

`public static function isEqual(p1:flashx.textLayout.formats:ITextLayoutFormat, p2:flashx.textLayout.formats:ITextLayoutFormat):Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Compares properties in ITextLayoutFormat instance `p1` with properties in ITextLayoutFormat instance `p2` and returns `true` if all properties match.

Parameters

| `p1:flashx.textLayout.formats:ITextLayoutFormat` — instance to compare to `p2`.
| `p2:flashx.textLayout.formats:ITextLayoutFormat` — instance to compare to `p1`.

Returns

| `Boolean` — true if all properties match, false otherwise.

### removeClashing

()
method

`public function removeClashing(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets properties in this TextLayoutFormat object to `undefined` if they do not match those in the `incoming` ITextLayoutFormat instance.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — instance against which to compare this TextLayoutFormat object's property values.

Example ( How to use this example )
This example calls removeClashing() to remove from textLayoutFormat2 any formatting values that are different in textLayoutFormat. It sets the differing values to `undefined`, cancelling the values that were applied.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_removeClashingExample extends Sprite
        {
            public function TextLayoutFormat_removeClashingExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes for textLayoutFormat2
                textLayoutFormat.textIndent = 8;
                textLayoutFormat.color = 0x336633;
                textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
                textLayoutFormat.fontSize = 24;
                // set fontFamily to same value for textLayoutFormat2
                textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";
                // add text to the span, the span to the paragraph, and the paragraph to the text flow.
                span.text = "Notice that fontFamily (Arial, Helvetica, _sans) is applied."
                p.addChild( span);
                textFlow.addChild(p);
                // call removeClashing(), cancelling any values that clash with textLayoutFormat;
                // assign it to the text flow
                textLayoutFormat.removeClashing(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add paragraph to textFlow and update controller to display it
                textFlow.addChild(p);
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### removeMatching

()
method

`public function removeMatching(incoming:flashx.textLayout.formats:ITextLayoutFormat):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets properties in this TextLayoutFormat object to `undefined` if they match those in the `incoming` ITextLayoutFormat instance.

Parameters

| `incoming:flashx.textLayout.formats:ITextLayoutFormat` — instance against which to compare this TextLayoutFormat object's property values.

Example ( How to use this example )
This example calls removeMatching() to remove from textLayoutFormat any formatting values that match those in textLayoutFormat2.
Copy

    package flashx.textLayout.formats.examples {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TextLayoutFormat;

        public class TextLayoutFormat_removeMatchingExample extends Sprite
        {
            public function TextLayoutFormat_removeMatchingExample()
            {
                // create a container and add it to the stage
                var container:Sprite = new Sprite();
                this.stage.addChild(container);
                // create TextFlow, ParagraphElement, and SpanElement objects
                var textFlow:TextFlow = new TextFlow();
                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                // create two TextLayoutFormat objects
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                var textLayoutFormat2:TextLayoutFormat = new TextLayoutFormat();
                // set format attributes for textLayoutFormat
                textLayoutFormat.textIndent = 8;
                textLayoutFormat.color = 0x336633;
                textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
                textLayoutFormat.fontSize = 24;
                // add text to the span, the span to the paragraph, and the paragraph to the text flow
                span.text = "Notice that fontFamily (Arial, Helvetica, _sans) is not applied."
                p.addChild( span);
                textFlow.addChild(p);
                // set fontFamily to same value for textLayoutFormat2
                textLayoutFormat2.fontFamily = "Arial, Helvetica, _sans";
                // call removeMatching() to remove any values that match textLayoutFormat2;
                // assign textLayoutFormat to the text flow
                textLayoutFormat.removeMatching(textLayoutFormat2);
                textFlow.hostFormat = textLayoutFormat;
                // add paragraph to textFlow and update controller to display it
                textFlow.addChild(p);
                var controller:ContainerController = new ContainerController(container, 200, 200 );
                textFlow.flowComposer.addController(controller);
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

### setStyle

()
method

`public function setStyle(styleProp:String, newValue:*):void`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5

Sets the style specified by the `styleProp` parameter to the value specified by the `newValue` parameter.

Parameters

| `styleProp:String` — The name of the style to set.
| `newValue:*` — The value to which to set the style.

Examples How to use this example
TextLayoutFormatExample.as
This example formats a paragraph with 15 pixel margins, a 20 pixel first line indent, and a left-aligned tab stop at 40 pixels. It uses the Arial font (with alternate device fonts), sets the size to 14 pixels, the color to green, turns on kerning, and sets leading (`lineHeight`) is to 140%.
Copy

    package flashx.textLayout.formats.examples
    {
        import flash.display.Sprite;
        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.elements.ParagraphElement;
        import flashx.textLayout.elements.SpanElement;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.TabStopFormat;
        import flashx.textLayout.formats.TextLayoutFormat;
        import flash.text.engine.TabAlignment;

        public class TextLayoutFormatExample extends Sprite
        {
            public function TextLayoutFormatExample()
            {
                var textFlow:TextFlow = new TextFlow();
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                textLayoutFormat.paragraphStartIndent = 15;
                textLayoutFormat.paragraphSpaceBefore = 15;
                textLayoutFormat.paragraphEndIndent = 15;
                textLayoutFormat.paragraphSpaceAfter = 15;
                textLayoutFormat.textIndent = 20;
                textLayoutFormat.color = 0x336633;
                textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
                textLayoutFormat.fontSize = 14;
                textLayoutFormat.kerning = flash.text.engine.Kerning.ON;
                textLayoutFormat.lineHeight = "140%";

                var tabStop1:TabStopFormat = new TabStopFormat();
                tabStop1.alignment = flash.text.engine.TabAlignment.START;
                tabStop1.position = 40;
                textLayoutFormat.tabStops = new Array(tabStop1);
                textFlow.hostFormat = textLayoutFormat;

                var p:ParagraphElement = new ParagraphElement();
                var span:SpanElement = new SpanElement();
                span.text = "This example formats a paragraph with 15 pixel margins, a 20 pixel first " +
                     "line indent, and a left-aligned tab stop at 40 pixels (last line). It uses the " +
                     "Arial font (with alternate device fonts), sets the size to 14 pixels, the color to green, " +
                     " turns on kerning, \n \t and sets leading (lineHeight) to 140%.";
                p.addChildAt(0, span);
                textFlow.addChildAt(0, p);

                textFlow.flowComposer.addController(new ContainerController(this,310,200));
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

TextLayoutFormatExample2.as
This example converts a string of Japanese characters in Unicode to a text flow and sets TextLayoutFormat properties to display it vertically, from right to left.
Copy

    package flashx.textLayout.formats.examples
    {
        import flash.display.Sprite;
        import flash.system.Capabilities;

        import flashx.textLayout.container.ContainerController;
        import flashx.textLayout.conversion.TextConverter;
        import flashx.textLayout.elements.TextFlow;
        import flashx.textLayout.formats.BlockProgression;
        import flashx.textLayout.formats.JustificationRule;
        import flashx.textLayout.formats.TextLayoutFormat;
        import flashx.textLayout.formats.VerticalAlign;

        public class TextLayoutFormatExample2 extends Sprite
        {
            public function TextLayoutFormatExample2()
            {
                // create TextFlow object
                var textFlow:TextFlow = new TextFlow();
                // create TextLayoutFormat object
                var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
                // define Japanese text in a string of Unicode characters
                var jaText:String = String.fromCharCode(
                    0x30AF, 0x30ED, 0x30B9, 0x30D7, 0x30E9, 0x30C3, 0x30C8, 0x30D5,
                    0x30A9, 0x30FC, 0x30E0, 0x4E0A, 0x3067, 0x518D, 0x751F, 0x53EF,
                    0x80FD, 0x306A
                ) +
                "Flash Video" +
                String.fromCharCode(
                    0x3092, 0x914D, 0x4FE1, 0x3001, 0x653F, 0x5E9C, 0x6700, 0x65B0,
                    0x60C5, 0x5831, 0x3092, 0x3088, 0x308A, 0x591A, 0x304F, 0x306E,
                    0x56FD, 0x6C11, 0x306B, 0x9AD8, 0x54C1, 0x8CEA, 0x306A, 0x753B,
                    0x50CF, 0x3067, 0x7C21, 0x5358, 0x304B, 0x3064, 0x30EA, 0x30A2,
                    0x30EB, 0x30BF, 0x30A4, 0x30E0, 0x306B, 0x63D0, 0x4F9B, 0x3059,
                    0x308B, 0x3053, 0x3068, 0x304C, 0x53EF, 0x80FD, 0x306B, 0x306A,
                    0x308A, 0x307e, 0x3057, 0x305F, 0x3002);
                // convert the text into a TextFlow object
                textFlow = TextConverter.importToFlow(jaText, TextConverter.PLAIN_TEXT_FORMAT);
                // set the locale and fontFamily
                textLayoutFormat.locale = "ja";
                if (Capabilities.os.search("Mac OS") > -1)
                    textLayoutFormat.fontFamily = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; // "Kozuka Mincho Pro R"                    koFont.fontName = "Adobe " + String.fromCharCode(0xBA85, 0xC870) + " Std M"; // "Adobe Myungjo Std M"
                else
                    textLayoutFormat.fontFamily = "Kozuka Mincho Pro R";
                // specify right-to-left block progression, east Asian justification, and top vertical alignment
                textLayoutFormat.blockProgression = BlockProgression.RL;
                textLayoutFormat.justificationRule = JustificationRule.EAST_ASIAN;
                textLayoutFormat.verticalAlign = VerticalAlign.TOP;
                textFlow.hostFormat = textLayoutFormat;
                // add controller and update to display text
                textFlow.flowComposer.addController(new ContainerController(this, 300, 200));
                textFlow.flowComposer.updateAllControllers();
            }
        }
    }

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00