TextWrapPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| applyToMasterPageOnly | bool | r/w | 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 | bool | r/w | If true, inverts the text wrap. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | ApplicationButton Document EPS EPSText FormField Graphic GraphicLine Group Image ImportedPage MediaItem Movie MultiStateObject Oval PageItem PICT Polygon Rectangle Sound SplineItem TextFrame WMF |
readonly | The 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 or Document). |
| paths | Paths Path | readonly | A collection of paths. |
| preferences | Preferences Preference | readonly | A collection of preferences objects. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| textWrapMode | TextWrapModes: TextWrapModes.NONE TextWrapModes.JUMP_OBJECT_TEXT_WRAP TextWrapModes.NEXT_COLUMN_TEXT_WRAP TextWrapModes.BOUNDING_BOX_TEXT_WRAP TextWrapModes.CONTOUR |
r/w | The text wrap mode. |
| textWrapOffset |
Array
of Units NothingEnum Unit |
r/w | 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.LEFT_SIDE TextWrapSideOptions.RIGHT_SIDE TextWrapSideOptions.SIDE_TOWARDS_SPINE TextWrapSideOptions.SIDE_AWAY_FROM_SPINE TextWrapSideOptions.LARGEST_AREA |
r/w | Text wrap side options. |
| userModifiedWrap | bool | readonly | If 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the TextWrapPreference.
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
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, 29-Apr-2012 v3.0.3i | Contents :: Index |