ClippingPathSettings

Methods:

convertToFrame, getElements, toSource, toSpecifier

Property Listing

Property	Type	Access	Description
alphaChannelPathNames	Array of String	readonly	A list of the alpha channels stored in the graphic.
appliedPathName	String	read/write	The name of the Photoshop path or alpha channel to use as a clipping path.
clippingType	ClippingPathType ClippingPathType.ALPHA_CHANNEL ClippingPathType.DETECT_EDGES ClippingPathType.NONE ClippingPathType.PHOTOSHOP_PATH ClippingPathType.USER_MODIFIED_PATH	read/write	The clipping path type.
includeInsideEdges	Boolean	read/write	If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
insetFrame	Number String	read/write	Shrinks the area enclosed by the clipping path by the specified amount. (Range depends on the unit. For points: -10000 to 10000; picas: -833p4 to 833p4; inches: -138.8889 to 138.8889; mm: -3527.778 to 3527.778; cm: -352.7778 to 352.7778; ciceros: -781c11.889 to 781c11.889)
invertPath	Boolean	read/write	If true, inverts the clipping path.
parent	EPS PICT WMF Image PDF	readonly	The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT or PDF).
paths	Paths Path	readonly	A collection of paths.
photoshopPathNames	Array of String	readonly	A list of the clipping paths stored in the graphic.
properties	Object	read/write	A property that allows setting of several properties at the same time.
restrictToFrame	Boolean	read/write	If true, truncates the clipping path at the edge of the frame containing the graphic. Note: Valid only when clipping type is alpha channel or detect edges.
threshold	Number (range 0 - 255)	read/write	The lowest value (darkest) pixel to allow in the image. All pixels in the image whose values are greater than (lighter than) the threshold value are clipped (obscured). (Range: 0 to 255) Note: Valid only when clipping type is detect edges or alpha channel.
tolerance	Number (range 0 - 10)	read/write	Specifies how similar a pixel's intensity value can be to the threshold value before the pixel is obscured by the clipping path. (Range: 0 to 10) Note: Valid only when clipping type is detect edges or alpha channel.
useHighResolutionImage	Boolean	read/write	If true, uses the high-resolution version of the graphic to create the clipping path. If false, calculates the clipping path based on screen-display resolution. Note: Valid only when clipping type is detect edges.

Method Listing

PageItem convertToFrame ()

Converts the clipping path to a frame.

Object getElements ()

Resolves the object specifier, creating an array of object references.

String toSource ()

Generates a string which, if executed, will return the ClippingPathSettings.

String toSpecifier ()

Retrieves the object specifier.

Object of

Image.clippingPath

EPS.clippingPath

PDF.clippingPath

WMF.clippingPath

PICT.clippingPath

Path.parent