K4 InDesign Javascript API Documentation

LayoutTextWrapPreference

Text wrap preferences.

Extends

Instance Properties

Name Description Access
applyToMasterPageOnly bool 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. read-write
contourOptions ContourOption The contour of the text wrap. Valid only when when text wrap type is contour. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
inverse bool If true, inverts the text wrap. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent 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, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, EndnoteTextFrame, Application, Document or ObjectStyle). read-only
paths Paths A collection of paths. read-only
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write
textWrapMode TextWrapModes The text wrap mode. read-write
textWrapOffset 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. read-write
textWrapSide TextWrapSideOptions Text wrap side options. read-write
userModifiedWrap bool If true, the text wrap path has been explicitly modified by the user. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → TextWrapPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → TextWrapPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TextWrapPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.