TextWrapPreference

Text wrap preferences.

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, ContourOption, NothingEnum, Object, Paths, TextWrapSideOptions, TextWrapTypes,

Preferences:

ContourOption

Property Listing

Property

Type

Access

Description

applyToMasterPageOnly

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.

contourOptions

ContourOption

readonly

The contour of the text wrap. Valid only when when text wrap type is contour.

inverse

Boolean

read/write

If true, inverts the text wrap.

parent

Application

Button

Document

EPS

FormField

GraphicLine

Group

Image

Oval

PDF

PICT

PageItem

Polygon

Rectangle

TextFrame

WMF

ImportedPage

ObjectStyle

readonly

The parent of the TextWrapPreference (a ObjectStyle, PageItem, Oval, Rectangle, GraphicLine, TextFrame, Polygon, Group, Button, FormField, Image, EPS, WMF, PICT, PDF, Application, Document or ImportedPage).

paths

Paths Path

readonly

A collection of paths.

properties

Object

read/write

A property that allows setting of several properties at the same time.

textWrapOffset

Array of Units

Unit

NothingEnum.NOTHING

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.

textWrapSide

TextWrapSideOptions

TextWrapSideOptions.BOTH_SIDES

TextWrapSideOptions.LARGEST_AREA

TextWrapSideOptions.LEFT_SIDE

TextWrapSideOptions.RIGHT_SIDE

TextWrapSideOptions.SIDE_AWAY_FROM_SPINE

TextWrapSideOptions.SIDE_TOWARDS_SPINE

read/write

Text wrap side options.

textWrapType

TextWrapTypes

TextWrapTypes.BOUNDING_BOX_TEXT_WRAP

TextWrapTypes.CONTOUR

TextWrapTypes.JUMP_OBJECT_TEXT_WRAP

TextWrapTypes.NEXT_COLUMN_TEXT_WRAP

TextWrapTypes.NONE

TextWrapTypes.USER_MODIFIED

read/write

The text wrap type.

Method Listing

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.

Object of

ContourOption.parent

Path.parent

FormField.textWrapPreferences

Button.textWrapPreferences

PageItem.textWrapPreferences

Oval.textWrapPreferences

Rectangle.textWrapPreferences

GraphicLine.textWrapPreferences

Polygon.textWrapPreferences

Group.textWrapPreferences

Image.textWrapPreferences

EPS.textWrapPreferences

PDF.textWrapPreferences

WMF.textWrapPreferences

PICT.textWrapPreferences

ImportedPage.textWrapPreferences

ObjectStyle.textWrapPreferences

TextFrame.textWrapPreferences

Return

TextWrapPreference.getElements()