A clipping path settings object.
Element
path
clipping path settings Properties
| Property | Type | Access | Description |
|---|---|---|---|
| alpha channel path names | List of string | read | A list of the alpha channels stored in the graphic. |
| applied path name | string | r/w | The name of the Photoshop path or alpha channel to use as a clipping path. |
| class | type class | read | The class descriptor type. |
| clipping type | none, detect edges, alpha channel, photoshop path, user modified path, |
r/w | The clipping path type. |
| include inside edges | boolean | 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. |
| inset frame | number or string | 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: -781c… |
| invert path | boolean | r/w | If true, inverts the clipping path. |
| object reference | clipping path settings | read | An object reference for the clipping path settings. |
| parent | reference | read | The parent of the clipping path settings (a image, EPS, WMF, PICT, PDF or imported page). Can return: image, EPS, WMF, PICT, PDF or imported page. |
| photoshop path names | List of string | read | A list of the clipping paths stored in the graphic. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| restrict to frame | boolean | 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 | integer | 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 chan… |
| tolerance | fixed | 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. |
| use high resolution image | boolean | 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. |