InDesign Server2025
API 20.5.0.49
Object

TextWrapPreference

Text wrap preferences.

Preference TextWrapPreference

Properties

NameType AccessDescription
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.
ContourOption readonly The contour of the text wrap. Valid only when when text wrap type is contour.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, inverts the text wrap.
Boolean readonly Returns true if the object specifier resolves to valid objects.
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<Path> readonly A collection of paths.
Preferences<Preference> readonly A collection of preferences objects.
Object read/write A property that allows setting of several properties at the same time.
TextWrapModes
read/write The text wrap mode.
Units[] | Unit[] | NothingEnum[]
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.
TextWrapSideOptions
read/write Text wrap side options.
Boolean readonly If true, the text wrap path has been explicitly modified by the user.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
TextWrapPreference[]

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

Boolean

Removes the event listener.

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.
String

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

String

Retrieves the object specifier.

Object of 40

Properties elsewhere that hold a TextWrapPreference.

Return 1

Methods that return a TextWrapPreference.