flashx.textLayout.operations.ApplyFormatToElementOperation - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flashx.textLayout.operations
Class	public class ApplyFormatToElementOperation
Inheritance	ApplyFormatToElementOperation FlowElementOperation FlowTextOperation FlowOperation 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.

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.	ApplyFormatToElementOperation
		originalSelectionState : SelectionState The selection state at the start of the operation.	FlowTextOperation
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ApplyFormatToElementOperation(operationState:SelectionState, targetElement:FlowElement, format:flashx.textLayout.formats:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1) Creates an ApplyFormatToElementOperation object.	ApplyFormatToElementOperation
		canUndo():Boolean Test if this operation be placed on the undo stack.	FlowOperation
		doOperation():Boolean Executes the operation.	FlowOperation
		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
		redo():SelectionState [override] Re-executes the operation.	FlowTextOperation
		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
		undo():SelectionState Reverses the operation.	FlowOperation
		valueOf():Object 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`)