Text wrap preferences.
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. |
| inverse | bool | r/w | If true, inverts the text wrap. |
| parent | any | readonly | The parent of the TextWrapPreference (a PageItem, Oval, Rectangle, GraphicLine, TextFrame, Polygon, Group, Button, FormField, Image, EPS, WMF, PICT, PDF, Application, Document, ObjectStyle or ImportedPage). |
| paths | Paths | readonly | A collection of paths. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| textWrapOffset | any | 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 : BOTH_SIDES LEFT_SIDE RIGHT_SIDE SIDE_TOWARDS_SPINE SIDE_AWAY_FROM_SPINE LARGEST_AREA |
r/w | Text wrap side options. |
| textWrapType | TextWrapTypes : NONE JUMP_OBJECT_TEXT_WRAP NEXT_COLUMN_TEXT_WRAP BOUNDING_BOX_TEXT_WRAP CONTOUR USER_MODIFIED |
r/w | The text wrap type. |
Methods
Array of TextWrapPreferencegetElements ()
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:
Button.textWrapPreferences
ContourOption.parent
EPS.textWrapPreferences
FormField.textWrapPreferences
GraphicLine.textWrapPreferences
Group.textWrapPreferences
Image.textWrapPreferences
ImportedPage.textWrapPreferences
ObjectStyle.textWrapPreferences
Oval.textWrapPreferences
PageItem.textWrapPreferences
PDF.textWrapPreferences
PICT.textWrapPreferences
Polygon.textWrapPreferences
Rectangle.textWrapPreferences
TextFrame.textWrapPreferences
WMF.textWrapPreferences
Returned by:
Array of TextWrapPreference TextWrapPreference .getElements (
)