flash.text

# StageTextInitOptions - AS3

Package | flash.text
Class | public class StageTextInitOptions
Inheritance | StageTextInitOptions Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

The StageTextInitOptions class defines the options available for initializing a StageText object.

Related API Elements

StageText

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | multiline : Boolean Specifies whether the StageText object displays multiple lines of text. | StageTextInitOptions

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | StageTextInitOptions(multiline:Boolean = false) Creates a StageTextInitOptions object. | StageTextInitOptions
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | 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

### multiline

property

`multiline:Boolean`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Specifies whether the StageText object displays multiple lines of text.

Implementation
`public function get multiline():Boolean`
`public function set multiline(value:Boolean):void`
Constructor Detail

### StageTextInitOptions

()
Constructor

`public function StageTextInitOptions(multiline:Boolean = false)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.0

Creates a StageTextInitOptions object.

Parameters

| `multiline:Boolean` (default = `false`)`` — set to `true` to create multiline StageText objects.

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