Class

TextWrapPreference

 Text wrap preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Button | Document | EPS | EPSText | FormField | Graphic | GraphicLine | Group | Image | ImportedPage | MediaItem | Movie | MultiStateObject | ObjectStyle | Oval | PageItem | PDF | PICT | Polygon | Rectangle | Sound | SplineItem | TextFrame | WMF
Preference
TextWrapPreference
ContourOption | Event | EventListener | MutationEvent | Path | Preference

Properties

PropertyTypeAccessDescription
applyToMasterPageOnlybool r/wIf true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to.
contourOptionsContourOption readonlyThe contour of the text wrap. Valid only when when text wrap type is contour.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
inversebool r/wIf true, inverts the text wrap.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Button
Document
EPS
EPSText
FormField
Graphic
GraphicLine
Group
Image
ImportedPage
MediaItem
Movie
MultiStateObject
ObjectStyle
Oval
PageItem
PDF
PICT
Polygon
Rectangle
Sound
SplineItem
TextFrame
WMF
readonlyThe parent of the TextWrapPreference (a PageItem, FormField, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, Application, Document or ObjectStyle).
pathsPaths readonlyA collection of paths.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
textWrapModeTextWrapModes:
TextWrapModes.NONE
TextWrapModes.JUMP_OBJECT_TEXT_WRAP
TextWrapModes.NEXT_COLUMN_TEXT_WRAP
TextWrapModes.BOUNDING_BOX_TEXT_WRAP
TextWrapModes.CONTOUR
r/wThe text wrap mode.
textWrapOffset Array of Units
NothingEnum
Unit
r/wThe 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.
textWrapSideTextWrapSideOptions:
TextWrapSideOptions.BOTH_SIDES
TextWrapSideOptions.LEFT_SIDE
TextWrapSideOptions.RIGHT_SIDE
TextWrapSideOptions.SIDE_TOWARDS_SPINE
TextWrapSideOptions.SIDE_AWAY_FROM_SPINE
TextWrapSideOptions.LARGEST_AREA
r/wText wrap side options.
userModifiedWrapbool readonlyIf true, the text wrap path has been explicitly modified by the user.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of TextWrapPreference getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.textWrapPreferences

Button.textWrapPreferences

ContourOption.parent

Document.textWrapPreferences

EPS.textWrapPreferences

EPSText.textWrapPreferences

FormField.textWrapPreferences

Graphic.textWrapPreferences

GraphicLine.textWrapPreferences

Group.textWrapPreferences

Image.textWrapPreferences

ImportedPage.textWrapPreferences

MediaItem.textWrapPreferences

Movie.textWrapPreferences

MultiStateObject.textWrapPreferences

ObjectStyle.textWrapPreferences

Oval.textWrapPreferences

PDF.textWrapPreferences

PICT.textWrapPreferences

PageItem.textWrapPreferences

Path.parent

Polygon.textWrapPreferences

Rectangle.textWrapPreferences

Sound.textWrapPreferences

SplineItem.textWrapPreferences

TextFrame.textWrapPreferences

WMF.textWrapPreferences

Return

Array of TextWrapPreference TextWrapPreference.getElements ()

Jongware, 17-May-2011 v3.0.3fContents :: Index