ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.operations 

ApplyFormatToElementOperation  - AS3

Packageflashx.textLayout.operations
Classpublic class ApplyFormatToElementOperation
InheritanceApplyFormatToElementOperation Inheritance FlowElementOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The ApplyFormatToElementOperation class encapsulates a style change to an element.

This operation applies one or more formats to a flow element.

Related API Elements



Public Properties
 PropertyDefined By
 InheritedabsoluteEnd : int
The absolute end point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedabsoluteStart : int
The absolute start point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedbeginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  format : flashx.textLayout.formats:ITextLayoutFormat
The character formats applied in this operation.
ApplyFormatToElementOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
 InheritedrelativeEnd : int
An offset from the start of the targetElement.
FlowElementOperation
 InheritedrelativeStart : int
An offset from the beginning of the targetElement.
FlowElementOperation
 InheritedtargetElement : FlowElement
Specifies the element this operation modifies.
FlowElementOperation
 InheritedtextFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
ApplyFormatToElementOperation(operationState:SelectionState, targetElement:FlowElement, format:flashx.textLayout.formats:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1)
Creates an ApplyFormatToElementOperation object.
ApplyFormatToElementOperation
 Inherited
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
Executes the operation.
FlowOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Reverses the operation.
FlowOperation
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

format

property
format:flashx.textLayout.formats:ITextLayoutFormat

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The character formats applied in this operation.

If null no character formats are changed.



Implementation
    public function get format():flashx.textLayout.formats:ITextLayoutFormat
    public function set format(value:flashx.textLayout.formats:ITextLayoutFormat):void
Constructor Detail

ApplyFormatToElementOperation

()Constructor
public function ApplyFormatToElementOperation(operationState:SelectionState, targetElement:FlowElement, format:flashx.textLayout.formats:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1)

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Creates an ApplyFormatToElementOperation object.

Parameters
operationState:SelectionState — Specifies the text flow containing the element to which this operation is applied.
 
targetElement:FlowElement — specifies the element to which this operation is applied.
 
format:flashx.textLayout.formats:ITextLayoutFormat — The formats to apply in this operation.
 
relativeStart:int (default = 0)
 
relativeEnd:int (default = -1)