mx.core.UITextFormat

	Property	Defined By
		antiAliasType : String Defines the anti-aliasing setting for the UITextField class.	UITextFormat
		direction : String The directionality of the text.	UITextFormat
		gridFitType : String Defines the grid-fitting setting for the UITextField class.	UITextFormat
		locale : String The locale of the text.	UITextFormat
		moduleFactory : IFlexModuleFactory The moduleFactory used to create TextFields for embedded fonts.	UITextFormat
		sharpness : Number Defines the sharpness setting for the UITextField class.	UITextFormat
		thickness : Number Defines the thickness setting for the UITextField class.	UITextFormat
		useFTE : Boolean = false Determines how the measureText() and measureHTMLText() methods do text measurement.	UITextFormat

	Method	Defined By
		UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null) Constructor.	UITextFormat
		measureHTMLText(htmlText:String, roundUp:Boolean = true):TextLineMetrics Returns measurement information for the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField, and using this UITextFormat object to define the text format.	UITextFormat
		measureText(text:String, roundUp:Boolean = true):TextLineMetrics Returns measurement information for the specified text, assuming that it is displayed in a single-line UITextField component, and using this UITextFormat object to define the text format.	UITextFormat

Property Detail

antiAliasType

property

public var antiAliasType:String

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Defines the anti-aliasing setting for the UITextField class. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the embedded font. Set this property to "normal" to disable the advanced anti-aliasing.

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is "advanced".

See also

flash.text.AntiAliasType

direction

property

public var direction:String

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The directionality of the text.

The allowed values are "ltr" for left-to-right text, as in Latin-style scripts, and "rtl" for right-to-left text, as in Arabic and Hebrew.

FTE and TLF use this value in their bidirectional text layout algorithm, which maps Unicode character order to glyph order.

Note: This style only applies when this UITextFormat is used with a UIFTETextField rather than a UITextField.

The default value is null.

gridFitType

property

public var gridFitType:String

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Defines the grid-fitting setting for the UITextField class. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is "pixel".

See also

flash.text.GridFitType

locale

property

public var locale:String

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The locale of the text.

FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.

Note: This style only applies when this UITextFormat is used with a UIFTETextField rather than a UITextField.

The default value is null.

moduleFactory

property

moduleFactory:IFlexModuleFactory

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

The moduleFactory used to create TextFields for embedded fonts.

Implementation
public function get moduleFactory():IFlexModuleFactory
public function set moduleFactory(value:IFlexModuleFactory):void

sharpness

property

public var sharpness:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Defines the sharpness setting for the UITextField class. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is 0.

See also

flash.text.TextField

thickness

property

public var thickness:Number

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Defines the thickness setting for the UITextField class. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This property has no effect for system fonts.

This property applies to all the text in a UITextField object; you cannot apply it to some characters and not others.

The default value is 0.

See also

flash.text.TextField

useFTE

property

public var useFTE:Boolean = false

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Determines how the measureText() and measureHTMLText() methods do text measurement.

If true, they use an offscreen instance of the FTETextField class in the Text Layout Framework. If false, they use an offscreen instance of the TextField class in the Flash Player.

The default value is false.

Constructor Detail

UITextFormat

()

Constructor

public function UITextFormat(systemManager:ISystemManager, font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`systemManager:ISystemManager` — A SystemManager object. The SystemManager keeps track of which fonts are embedded. Typically this is the SystemManager obtained from the `systemManager` property of UIComponent.

	`font:String` (default = `null`) — A String specifying the name of a font, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`size:Object` (default = `null`) — A Number specifying a font size in pixels, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`color:Object` (default = `null`) — An unsigned integer specifying the RGB color of the text, such as 0xFF0000 for red, or `null` to indicate that is UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`bold:Object` (default = `null`) — A Boolean flag specifying whether the text is bold, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`italic:Object` (default = `null`) — A Boolean flag specifying whether the text is italic, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`underline:Object` (default = `null`) — A Boolean flag specifying whether the text is underlined, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`url:String` (default = `null`) — A String specifying the URL to which the text is hyperlinked, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`target:String` (default = `null`) — A String specifying the target window where the hyperlinked URL is displayed. If the target window is `null` or an empty string, the hyperlinked page is displayed in the same browser window. If the `urlString` parameter is `null` or an empty string, this property has no effect. This parameter is optional, with a default value of `null`.

	`align:String` (default = `null`) — A String specifying the alignment of the paragraph, as a flash.text.TextFormatAlign value, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`leftMargin:Object` (default = `null`) — A Number specifying the left margin of the paragraph, in pixels, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`rightMargin:Object` (default = `null`) — A Number specifying the right margin of the paragraph, in pixels, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`indent:Object` (default = `null`) — A Number specifying the indentation from the left margin to the first character in the paragraph, in pixels, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

	`leading:Object` (default = `null`) — A Number specifying the amount of additional vertical space between lines, or `null` to indicate that this UITextFormat doesn't specify this property. This parameter is optional, with a default value of `null`.

See also

flash.text.TextFormatAlign

Method Detail

measureHTMLText

()

method

public function measureHTMLText(htmlText:String, roundUp:Boolean = true):TextLineMetrics

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Returns measurement information for the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField, and using this UITextFormat object to define the text format.

Parameters

	`htmlText:String` — A String specifying the HTML text to measure.

	`roundUp:Boolean` (default = `true`) — A Boolean flag specifying whether to round up the the measured width and height to the nearest integer. Rounding up is appropriate in most circumstances.

Returns

TextLineMetrics — A TextLineMetrics object containing the text measurements.

See also

flash.text.TextLineMetrics

measureText

()

method

public function measureText(text:String, roundUp:Boolean = true):TextLineMetrics

Language Version :

ActionScript 3.0

Product Version :

Flex 3

Runtime Versions :

Flash Player 9, AIR 1.1

Returns measurement information for the specified text, assuming that it is displayed in a single-line UITextField component, and using this UITextFormat object to define the text format.

Parameters

	`text:String` — A String specifying the text to measure.

	`roundUp:Boolean` (default = `true`) — A Boolean flag specifying whether to round up the the measured width and height to the nearest integer. Rounding up is appropriate in most circumstances.

Returns

TextLineMetrics — A TextLineMetrics object containing the text measurements.

See also

flash.text.TextLineMetrics

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
UITextFormat	Properties \| Methods

Package	mx.core
Class	public class UITextFormat
Inheritance	UITextFormat flash.text.TextFormat