StyleSheet (TextField.StyleSheet)

Object
    |
    +-TextField.StyleSheet

public class StyleSheet
extends Object

The StyleSheet class lets you create a StyleSheet object that contains text formatting rules for font size, color, and other styles. You can then apply styles defined by a style sheet to a TextField object that contains HTML- or XML-formatted text. The text in the TextField object is automatically formatted according to the tag styles defined by the StyleSheet object. You can use text styles to define new formatting tags, redefine built-in HTML tags, or create style classes that you can apply to certain HTML tags.

To apply styles to a TextField object, assign the StyleSheet object to a TextField object's styleSheet property.

Note: A text field with a style sheet applied to it is not editable. In other words, a text field with the type property set to "input" applies the style sheet formatting to the default text for the text field, but the content will no longer be editable by the user. Consider using the TextFormat class to assign styles to input text fields.

Flash Player supports a subset of properties in the original CSS1 specification (www.w3.org/TR/REC-CSS1). The following table shows the supported Cascading Style Sheet (CSS) properties and values, as well as their corresponding ActionScript property names. (Each ActionScript property name is derived from the corresponding CSS property name; if the name contains a hyphen, the hyphen is omitted and the subsequent character is capitalized.)

CSS property	ActionScript property	Usage and supported values
`color`	`color`	Only hexadecimal color values are supported. Named colors (such as `blue`) are not supported. Colors are written in the following format: `#FF0000`.
`display`	`display`	Supported values are `inline`, `block`, and `none`.
`font-family`	`fontFamily`	A comma-separated list of fonts to use, in descending order of desirability. Any font family name can be used. If you specify a generic font name, it is converted to an appropriate device font. The following font conversions are available: `mono` is converted to `_typewriter`, `sans-serif` is converted to `_sans`, and `serif` is converted to `_serif`.
`font-size`	`fontSize`	Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
`font-style`	`fontStyle`	Recognized values are `normal` and `italic`.
`font-weight`	`fontWeight`	Recognized values are `normal` and `bold`.
`kerning`	`kerning`	Recognized values are `true` and `false`. Kerning is supported for embedded fonts only. Certain fonts, such as Courier New, do not support kerning. The kerning property is only supported in SWF files created in Windows, not in SWF files created on the Macintosh. However, these SWF files can be played in non-Windows versions of Flash Player and the kerning still applies.
`leading`	`leading`	The amount of space that is uniformly distributed between lines. The value specifies the number of pixels that are added after each line. A negative value condenses the space between lines. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent. Available in Flash Player 8 and later.
`letter-spacing`	`letterSpacing`	The amount of space that is uniformly distributed between characters. The value specifies the number of pixels that are added to the advance after each character. A negative value condenses the space between characters. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
`margin-left`	`marginLeft`	Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
`margin-right`	`marginRight`	Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
`text-align`	`textAlign`	Recognized values are `left`, `center`, `right`, and `justify`.
`text-decoration`	`textDecoration`	Recognized values are `none` and `underline`.
`text-indent`	`textIndent`	Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.

Availability: ActionScript 1.0; Flash Player 7

Property summary

Properties inherited from class Object

constructor (Object.constructor property), __proto__ (Object.__proto__ property), prototype (Object.prototype property), __resolve (Object.__resolve property)

Event summary

Event	Description
onLoad `= function(success:`Boolean`) {}`	Invoked when a `load()` operation has completed.

Constructor summary

Signature	Description
StyleSheet`()`	Creates a StyleSheet object.

Method summary

Modifiers	Signature	Description
	clear`() : Void`	Removes all styles from the specified StyleSheet object.
	getStyle`(name:`String`) :` Object	Returns a copy of the style object associated with the specified style (`name`).
	getStyleNames`() :` Array	Returns an array that contains the names (as strings) of all of the styles registered in this style sheet.
	load`(url:`String`) :` Boolean	Starts loading the CSS file into the StyleSheet.
	parseCSS`(cssText:`String`) :` Boolean	Parses the CSS in `cssText` and loads the StyleSheet with it.
	setStyle`(name:`String`, style:`Object`) : Void`	Adds a new style with the specified name to the StyleSheet object.
	transform`(style:`Object`) :` TextFormat	Extends the CSS parsing capability.

Methods inherited from class Object

addProperty (Object.addProperty method), hasOwnProperty (Object.hasOwnProperty method), isPropertyEnumerable (Object.isPropertyEnumerable method), isPrototypeOf (Object.isPrototypeOf method), registerClass (Object.registerClass method), toString (Object.toString method), unwatch (Object.unwatch method), valueOf (Object.valueOf method), watch (Object.watch method)

View comments on LiveDocs

StyleSheet (TextField.StyleSheet)

See also

Property summary

Event summary

Constructor summary

Method summary