Change object preferences.
change object preference Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchor point | anything | r/w | The point in the anchored object to position. Can return: top left anchor/top center anchor/top right anchor/left center anchor/center anchor/right center anchor/bottom left anchor/bottom center anchor/bottom right anchor or nothing. |
| anchor space above | anything | r/w | The space above an above-line anchored object. Can return: number or string or nothing. |
| anchor xoffset | anything | r/w | The horizontal (x) offset of the anchored object. Can return: number or string or nothing. |
| anchor yoffset | anything | r/w | The vertical (y) offset of the anchored object. Can return: number or string or nothing. |
| anchored position | anything | r/w | The position of the anchored object relative to the anchor. Can return: inline position/above line/anchored or nothing. |
| applied object styles | anything | r/w | The applied object style(s). Can return: string or nothing. Can also accept: object style. |
| baseline frame grid color | anything | r/w | The grid line color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: list of 3 fixed (0 – 255), light blue/red/green/blue/yellow/magenta/cyan/gray/black/orange… |
| baseline frame grid increment | anything | r/w | The distance between grid lines. Can return: number or string (1 – 8640 points) or nothing (1 – 8640). |
| baseline frame grid relative option | anything | r/w | The object from which to offset the custom baseline grid. Can return: top of page/top of margin/top of frame/top of inset or nothing. |
| bottom crop | anything | r/w | The amount in measurement units to crop the bottom edge of a graphic. Can return: number or string or nothing. |
| class | anything | read | The class descriptor type. Can return: integer or nothing. |
| content transparency settings | anything | read | Transparency settings for the content of the change object preference. Can return: content transparency setting or nothing. |
| contour type | anything | r/w | The contour type. Can return: bounding box/photoshop path/detect edges/alpha channel/graphic frame/same as clipping or nothing. |
| corner option | anything | r/w | The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight. Can return: none/rounded cor… |
| corner radius | anything | r/w | The radius in measurement units of the corner effect. Can return: number or string or nothing. |
| end cap | anything | r/w | The end shape of an open path. Can return: butt end cap/round end cap/projecting end cap or nothing. |
| end join | anything | r/w | The corner join applied to the change object preference. Can return: miter end join/round end join/bevel end join or nothing. |
| fill color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the to fill the change object preference. . Can return: swatch or nothing. Can also accept: string. |
| fill tint | anything | r/w | The percent of tint to use in the change object preference’s fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: fixed or nothing. |
| fill transparency settings | anything | read | Transparency settings for the fill applied to the change object preference. Can return: fill transparency setting or nothing. |
| first baseline offset | anything | r/w | The distance between the baseline of the text and the top inset of the change object preference. Can return: ascent offset/cap height/leading offset/embox height/x height/fixed height or nothing. |
| fitting alignment | anything | r/w | The point with which to align the image empty when fitting in a frame. For information, see frame fitting options. Can return: top left anchor/top center anchor/top right anchor/left center anchor/center anchor/right center anchor/bottom left anchor/bo… |
| fitting on empty frame | anything | r/w | The frame fitting option to apply to placed or pasted content if the frame is empty. Can be applied to a frame, object style, or document or to the application. Can return: none/content to frame/proportionally/fill proportionally or nothing. |
| gap color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. Can return: swatch or nothing. |
| gap tint | anything | r/w | The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: fixed or nothing. |
| gradient fill angle | anything | r/w | The angle of a linear gradient applied to the fill of the change object preference. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient stroke angle | anything | r/w | The angle of a linear gradient applied to the stroke of the change object preference. (Range: -180 to 180). Can return: fixed or nothing. |
| horizontal alignment | anything | r/w | When anchored position is above line, the position of the anchored object is relative to the text area. When anchored position is custom, the horizontal alignment of the anchored object is set by the horizontal reference point. Note: Not valid when anc… |
| horizontal reference point | anything | r/w | The horizontal reference point on the page. Valid only when anchored position is custom. Can return: column edge/text frame/page margins/page edge/anchor location or nothing. |
| ignore wrap | anything | r/w | If true, ignores text wrap settings for drawn or placed objects in the text frame. . Can return: boolean or nothing. |
| include inside edges | anything | 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. . Can return: boolean or nothing. |
| inset spacing | anything | r/w | The amount to offset text from the edges of the text frame, specified either as a single value applied uniformly to all sides of the text frame or as an array of 4 values in the format [top inset, left inset, bottom inset, right inset]. Can return: num… |
| inverse | anything | r/w | If true, inverts the text wrap. Can return: boolean or nothing. |
| left crop | anything | r/w | The amount in measurement units to crop the left edge of a graphic. Can return: number or string or nothing. |
| left line end | anything | r/w | The arrowhead applied to the start of the path. . Can return: none/simple arrow head/simple wide arrow head/triangle arrow head/triangle wide arrow head/barbed arrow head/curved arrow head/circle arrow head/circle solid arrow head/square arrow head/squ… |
| lock position | anything | r/w | If true, prevents manual positioning of the anchored object. Can return: boolean or nothing. |
| minimum first baseline offset | anything | r/w | The minimum distance between the baseline of the text and the top inset of the change object preference. Can return: number or string (0 – 8640 points) or nothing (0 – 8640). |
| miter limit | anything | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500). Can return: fixed or nothing. |
| nonprinting | anything | r/w | If true, the change object preference does not print. Can return: boolean or nothing. |
| object reference | anything | read | An object reference for the change object preference. Can return: change object preference or nothing. |
| optical margin alignment | anything | r/w | If true, adjust the position of characters at the edges of the frame to provide a better appearance. Can return: boolean or nothing. |
| optical margin size | anything | r/w | The point size used as a base for calculating optical margin alginment. (Range: 0.1 to 1296). Can return: number or string (0.1 – 1296 points) or nothing (0.1 – 1296). |
| overprint fill | anything | r/w | If true, the change object preference’s fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. Can return: boolean or nothing. |
| overprint gap | anything | r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. Can return: boolean or nothing. |
| overprint stroke | anything | r/w | If true, the change object preference’s stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. Can return: boolean or nothing. |
| parent | anything | read | The parent of the change object preference (a application). Can return: application or nothing. |
| pin position | anything | r/w | If true, pins the position of the anchored object within the text frame top and bottom. Can return: boolean or nothing. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right crop | anything | r/w | The amount in measurement units to crop the right edge of a graphic. Can return: number or string or nothing. |
| right line end | anything | r/w | The arrowhead applied to the end of the path. Can return: none/simple arrow head/simple wide arrow head/triangle arrow head/triangle wide arrow head/barbed arrow head/curved arrow head/circle arrow head/circle solid arrow head/square arrow head/square … |
| spine relative | anything | r/w | If true, the position of the anchored object is relative to the binding spine of the page or spread. Can return: boolean or nothing. |
| starting offset for baseline frame grid | anything | r/w | The amount to offset the baseline grid. Can return: number or string (0 – 8640 points) or nothing (0 – 8640). |
| stroke alignment | anything | r/w | The stroke alignment applied to the change object preference. Can return: center alignment/inside alignment/outside alignment or nothing. |
| stroke color | anything | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the to stroke of the change object preference. Can return: swatch or nothing. Can also accept: string. |
| stroke corner adjustment | anything | r/w | The corner adjustment applied to the change object preference. Can return: none/dashes/gaps/dashes and gaps or nothing. |
| stroke dash and gap | anything | r/w | The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. Can return: list of numbers or strings or nothing. |
| stroke tint | anything | r/w | The percent of tint to use in object’s stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.). Can return: fixed or nothing. |
| stroke transparency settings | anything | read | Transparency settings for the stroke. Can return: stroke transparency setting or nothing. |
| stroke type | anything | r/w | The name of the stroke style to apply. Can return: stroke style or nothing. Can also accept: string. |
| stroke weight | anything | r/w | The weight (in points) to apply to the change object preference’s stroke. Can return: number or string or nothing. |
| text column count | anything | r/w | The number of columns in the text frame. Note: Depending on the value of use fixed column width, the number of columns can change automatically when the text frame size changes. Can return: integer (1 – 40) or nothing (1 – 40). |
| text column fixed width | anything | r/w | The column width of the columns in the text frame. Can return: number or string (0 – 8640 points) or nothing (0 – 8640). |
| text column gutter | anything | r/w | The space between columns in the text frame. Can return: number or string (0 – 8640 points) or nothing (0 – 8640). |
| text wrap offset | anything | r/w | 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 ty… |
| text wrap type | anything | r/w | The text wrap type. . Can return: none/jump object text wrap/next column text wrap/bounding box text wrap/contour/user modified or nothing. |
| top crop | anything | r/w | The amount in measurement units to crop the top edge of a graphic. Can return: number or string or nothing. |
| transparency settings | anything | read | Transparency settings. Can return: transparency setting or nothing. |
| use custom baseline frame grid | anything | r/w | If true, uses a custom baseline frame grid. Can return: boolean or nothing. |
| use fixed column width | anything | r/w | If true, maintains column width when the text frame is resized. If false, causes columns to resize when the text frame is resized. Note: When true, resizing the frame can change the number of columns in the frame. Can return: boolean or nothing. |
| vertical alignment | anything | r/w | The vertical alignment of the anchored object reference point with the vertical reference point on the page. Notes: Valid only when anchored position is custom. Can return: top align/bottom align/center align or nothing. |
| vertical justification | anything | r/w | The vertical alignment of the text content. . Can return: top align/center align/bottom align/justify align or nothing. |
| vertical reference point | anything | r/w | The vertical reference point on the page. Valid when anchored position is custom. Can return: column edge/text frame/page margins/page edge/line baseline/line xheight/line ascent/capheight/top of leading or nothing. |
| vertical threshold | anything | r/w | The maximum amount of vertical space between two paragraphs. Note: Valid only when vertical justification is justified; the specified amount is applied in addition to the space before or space after values defined for the paragraph. Can return: number … |