ClippingPathSettings

A clipping path settings object.

Properties

Property Type Access Description
alphaChannelPathNames Array of string readonly A list of the alpha channels stored in the graphic.
appliedPathName string r/w The name of the Photoshop path or alpha channel to use as a clipping path.
clippingType ClippingPathType :
NONE
DETECT_EDGES
ALPHA_CHANNEL
PHOTOSHOP_PATH
USER_MODIFIED_PATH		 r/w The clipping path type.
includeInsideEdges bool r/w 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 r/w 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 bool r/w If true, inverts the clipping path.
parent any readonly The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
paths Paths readonly A collection of paths.
photoshopPathNames Array of string readonly A list of the clipping paths stored in the graphic.
properties Object r/w A property that allows setting of several properties at the same time.
restrictToFrame bool r/w 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 r/w 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 r/w 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 bool r/w 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.

Methods

PageItem convertToFrame ()
Converts the clipping path to a frame. Note: The frame belongs to the polygons collection.

Array of ClippingPathSettings 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.

Element of:

EPS.clippingPath
Image.clippingPath
ImportedPage.clippingPath
PDF.clippingPath
PICT.clippingPath
WMF.clippingPath

Returned by:

Array of ClippingPathSettings ClippingPathSettings.getElements ( )