| Package | flashx.textLayout.operations |
| Class | public class ClearFormatOnElementOperation |
| Inheritance | ClearFormatOnElementOperation  FlowElementOperation FlowTextOperation FlowOperation Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This operation undefines one or more formats to a flow element.
Related API Elements
flashx.textLayout.edit.EditManager
flashx.textLayout.formats.TextLayoutFormat
flashx.textLayout.events.FlowOperationEvent
ApplyFormatToElementOperation
flashx.textLayout.formats.TextLayoutFormat
flashx.textLayout.events.FlowOperationEvent
ApplyFormatToElementOperation
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | absoluteEnd : int
The absolute end point of the range of text to which this operation is applied. | FlowTextOperation | |
| absoluteStart : int
The absolute start point of the range of text to which this operation is applied. | FlowTextOperation | |
| beginGeneration : uint [read-only]
The text flow generation before the operation. | FlowOperation | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| endGeneration : uint [read-only]
The text flow generation after the operation. | FlowOperation | |
| format : flashx.textLayout.formats:ITextLayoutFormat
The character formats applied in this operation. | ClearFormatOnElementOperation | ||
| originalSelectionState : SelectionState
The selection state at the start of the operation. | FlowTextOperation | |
| relativeEnd : int
An offset from the start of the targetElement. | FlowElementOperation | |
| relativeStart : int
An offset from the beginning of the targetElement. | FlowElementOperation | |
| targetElement : FlowElement
Specifies the element this operation modifies. | FlowElementOperation | |
| textFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied. | FlowOperation | |
| userData : *
Arbitrary data associated with an element. | FlowOperation | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ClearFormatOnElementOperation(operationState:SelectionState, targetElement:FlowElement, format:flashx.textLayout.formats:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1)
Creates an ClearFormatOnElementOperation object. | ClearFormatOnElementOperation | ||
|
Test if this operation be placed on the undo stack. | FlowOperation | |
|
Executes the operation. | FlowOperation | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
| [override]
Re-executes the operation. | FlowTextOperation | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Reverses the operation. | FlowOperation | |
|
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):voidConstructor Detail
ClearFormatOnElementOperation | () | Constructor |
public function ClearFormatOnElementOperation(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 ClearFormatOnElementOperation object.
ParametersoperationState: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) |
Mon Apr 10 2017, 12:28 PM -07:00