Adobe InDesign CS6 (8.0) Object Model JS: ContourOption

InDesign CS6

Class

ContourOption

 A contour option. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextWrapPreference
Preference
ContourOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
alphaChannelPathNamesArray of string readonlyA list of the alpha channels stored in the graphic.
contourPathNamestring r/wThe alpha channel or Photoshop path to use for the contour option. Valid only when the contour options is photoshop path or alpha channel.
contourTypeContourOptionsTypes:
ContourOptionsTypes.BOUNDING_BOX
ContourOptionsTypes.PHOTOSHOP_PATH
ContourOptionsTypes.DETECT_EDGES
ContourOptionsTypes.ALPHA_CHANNEL
ContourOptionsTypes.GRAPHIC_FRAME
ContourOptionsTypes.SAME_AS_CLIPPING
r/wThe contour type.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
includeInsideEdgesbool r/wIf true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTextWrapPreference readonlyThe parent of the ContourOption (a TextWrapPreference).
photoshopPathNamesArray of string readonlyA list of the clipping paths stored in the graphic.
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the ContourOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

TextWrapPreference.contourOptions

Return

Array of ContourOption ContourOption.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index