Adobe InDesign CS4 (6.0) Object Model JS: TextWrapPreference

InDesign CS4

Class

TextWrapPreference

 Text wrap preferences. Base Class: Preference

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application | Button | Document | EPS | FormField | GraphicLine | Group | Image | ImportedPage | ObjectStyle | Oval | PageItem | PDF | PICT | Polygon | Rectangle | TextFrame | WMF
Preference
TextWrapPreference
ContourOption | Path

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.
inversebool r/wIf true, inverts the text wrap.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplicationButton
Document
EPS
FormField
GraphicLine
Group
Image
ImportedPage
ObjectStyle
Oval
PageItem
PDF
PICT
Polygon
Rectangle
TextFrame
WMF
readonlyThe parent of the TextWrapPreference (a PageItem, Oval, Rectangle, GraphicLine, TextFrame, Polygon, Group, Button, FormField, Image, EPS, WMF, PICT, PDF, Application, Document, ObjectStyle or ImportedPage).
pathsPaths readonlyA collection of paths.
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.
textWrapOffsetArray 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

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

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

FormField.textWrapPreferences

GraphicLine.textWrapPreferences

Group.textWrapPreferences

Image.textWrapPreferences

ImportedPage.textWrapPreferences

ObjectStyle.textWrapPreferences

Oval.textWrapPreferences

PDF.textWrapPreferences

PICT.textWrapPreferences

PageItem.textWrapPreferences

Path.parent

Polygon.textWrapPreferences

Rectangle.textWrapPreferences

TextFrame.textWrapPreferences

WMF.textWrapPreferences

Return

Array of TextWrapPreference TextWrapPreference.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index