TextWrapPreference

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ContourOption, EventListeners, Events, NothingEnum, Object, Paths, Preferences, TextWrapModes, TextWrapSideOptions,

Preferences:

ContourOption, Preferences

Hierarchy:

Superclass: Preference

Class: TextWrapPreference

Property Listing

Property	Type	Access	Description
applyToMasterPageOnly	Boolean	read/write	If true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to.
contourOptions	ContourOption	readonly	The contour of the text wrap. Valid only when when text wrap type is contour.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
inverse	Boolean	read/write	If true, inverts the text wrap.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	Application Button CheckBox ComboBox Document EPS EPSText EndnoteTextFrame FormField Graphic GraphicLine Group HtmlItem Image ImportedPage ListBox MediaItem Movie MultiStateObject Oval PDF PICT Polygon RadioButton Rectangle SVG SignatureField Sound SplineItem TextBox TextFrame WMF ObjectStyle PageItem	readonly	The parent of the TextWrapPreference (a PageItem, HtmlItem, FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, EndnoteTextFrame, Application, Document or ObjectStyle).
paths	Paths Path	readonly	A collection of paths.
preferences	Preferences Preference	readonly	A collection of preferences objects.
properties	Object	read/write	A property that allows setting of several properties at the same time.
textWrapMode	TextWrapModes TextWrapModes.BOUNDING_BOX_TEXT_WRAP TextWrapModes.CONTOUR TextWrapModes.JUMP_OBJECT_TEXT_WRAP TextWrapModes.NEXT_COLUMN_TEXT_WRAP TextWrapModes.NONE	read/write	The text wrap mode.
textWrapOffset	Array of Units Unit NothingEnum.NOTHING	read/write	The minimum space between text and the edges of the wrapped object. The format for defining text wrap offset values depends on the text wrap type. If text wrap type is jump object text wrap, specify 2 values in the format [top, bottom]. If text wrap type is next column text wrap or contour, specify a single value. For bounding box text wrap, specify 4 values in the format in the format [top, left, bottom, right]. . Can return: Unit, Array of Units or NothingEnum enumerator.
textWrapSide	TextWrapSideOptions TextWrapSideOptions.BOTH_SIDES TextWrapSideOptions.LARGEST_AREA TextWrapSideOptions.LEFT_SIDE TextWrapSideOptions.RIGHT_SIDE TextWrapSideOptions.SIDE_AWAY_FROM_SPINE TextWrapSideOptions.SIDE_TOWARDS_SPINE	read/write	Text wrap side options.
userModifiedWrap	Boolean	readonly	If true, the text wrap path has been explicitly modified by the user.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

TextWrapPreference getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the TextWrapPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

ContourOption.parent

Event.parent

EventListener.parent

MutationEvent.parent

Path.parent

Preference.parent

Application.textWrapPreferences

Document.textWrapPreferences

FormField.textWrapPreferences

Button.textWrapPreferences

MultiStateObject.textWrapPreferences

CheckBox.textWrapPreferences

ComboBox.textWrapPreferences

ListBox.textWrapPreferences

RadioButton.textWrapPreferences

TextBox.textWrapPreferences

SignatureField.textWrapPreferences

Movie.textWrapPreferences

Sound.textWrapPreferences

PageItem.textWrapPreferences

Oval.textWrapPreferences

Rectangle.textWrapPreferences

GraphicLine.textWrapPreferences

Polygon.textWrapPreferences

Group.textWrapPreferences

Image.textWrapPreferences

EPS.textWrapPreferences

PDF.textWrapPreferences

WMF.textWrapPreferences

PICT.textWrapPreferences

Graphic.textWrapPreferences

SplineItem.textWrapPreferences

EPSText.textWrapPreferences

ImportedPage.textWrapPreferences

SVG.textWrapPreferences

MediaItem.textWrapPreferences

HtmlItem.textWrapPreferences

ObjectStyle.textWrapPreferences

TextFrame.textWrapPreferences

EndnoteTextFrame.textWrapPreferences

Return

TextWrapPreference.getElements()