Find object preferences.
find object preference Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchor point | any | 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 | any | r/w | The space above an above-line anchored object. Can return: number or string or nothing. |
| anchor xoffset | any | r/w | The horizontal (x) offset of the anchored object. Can return: number or string or nothing. |
| anchor yoffset | any | r/w | The vertical (y) offset of the anchored object. Corresponds to the space after property for above line positioning. Can return: number or string or nothing. |
| anchored position | any | r/w | The position of the anchored object relative to the anchor. Can return: inline position/above line/anchored or nothing. |
| applied object styles | any | r/w | The applied object style(s). Can return: string or nothing. Can also accept: object style. |
| apply to master page only | any | r/w | If true, text wraps on the master spread apply to that spread only, and not to any pages the master spread has been applied to. Can return: boolean or nothing. |
| baseline frame grid color | any | 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) or light blue/red/green/blue/yellow/magenta/cyan/gray/black/oran… |
| baseline frame grid increment | any | r/w | The distance between grid lines. Can return: number or string (1 – 8640 points) or nothing. |
| baseline frame grid relative option | any | r/w | The location (top of page, top margin, top of frame, or frame inset) on which to base the custom baseline grid. Can return: top of page/top of margin/top of frame/top of inset or nothing. |
| bottom crop | any | r/w | The amount in measurement units to crop the bottom edge of a graphic. Can return: number or string or nothing. |
| class | type | read | The class descriptor type. |
| content transparency settings | any | read | Transparency settings for the content of the find object preference. Can return: find change content transparency setting or nothing. |
| contour type | any | r/w | The contour type. Can return: bounding box/photoshop path/detect edges/alpha channel/graphic frame/same as clipping or nothing. |
| corner option | any | 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 | any | r/w | The radius in measurement units of the corner effect. Can return: number or string or nothing. |
| end cap | any | r/w | The end shape of an open path. Can return: butt end cap/round end cap/projecting end cap or nothing. |
| end join | any | r/w | The corner join applied to the find object preference. Can return: miter end join/round end join/bevel end join or nothing. |
| fill color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the find object preference. . Can return: swatch or nothing. Can also accept: string. |
| fill tint | any | r/w | The percent of tint to use in the find 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 | any | read | Transparency settings for the fill applied to the find object preference. Can return: find change fill transparency setting or nothing. |
| first baseline offset | any | r/w | The distance between the baseline of the text and the top inset of the text frame or cell. Can return: ascent offset/cap height/leading offset/embox height/x height/fixed height or nothing. |
| fitting alignment | any | 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 | any | 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 | any | 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 | any | 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 | any | r/w | The angle of a linear gradient applied to the fill of the find object preference. (Range: -180 to 180). Can return: fixed or nothing. |
| gradient stroke angle | any | r/w | The angle of a linear gradient applied to the stroke of the find object preference. (Range: -180 to 180). Can return: fixed or nothing. |
| horizontal reference point | any | 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 | any | 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 | any | 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 | any | 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 | any | r/w | If true, inverts the text wrap. Can return: boolean or nothing. |
| left crop | any | 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 | any | 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 | any | r/w | If true, prevents manual positioning of the anchored object. Can return: boolean or nothing. |
| minimum first baseline offset | any | r/w | The minimum distance between the baseline of the text and the top inset of the text frame or cell. Can return: number or string (0 – 8640 points) or nothing. |
| miter limit | any | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. Can return: fixed (1 – 500) or nothing. |
| nonprinting | any | r/w | If true, the find object preference does not print. Can return: boolean or nothing. |
| object reference | find object preference | read | An object reference for the object. |
| optical margin alignment | any | 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 | any | r/w | The point size used as the basis for calculating optical margin alignment. (Range: 0.1 to 1296). Can return: number or string (0.1 – 1296 points) or nothing. |
| overprint fill | any | r/w | If true, the find 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 | any | 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 | any | r/w | If true, the find 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 | specifier | read | The parent of the find object preference (a application). |
| pin position | any | r/w | If true, pins the position of the anchored object within the text frame top and bottom. Can return: boolean or nothing. |
| position reference point | any | r/w | The point in the referenced object relative to which to position the anchored object. Notes: Valid only when anchored position is custom. Can return: top left anchor/top center anchor/top right anchor/left center anchor/center anchor/right center ancho… |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right crop | any | 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 | any | 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 | any | 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 | any | r/w | The amount to offset the baseline grid. Can return: number or string (0 – 8640 points) or nothing. |
| story direction | any | r/w | The direction of the story. Can return: left to right direction/right to left direction/unknown direction or nothing. |
| stroke alignment | any | r/w | The stroke alignment applied to the find object preference. Can return: center alignment/inside alignment/outside alignment or nothing. |
| stroke color | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the find object preference. Can return: swatch or nothing. Can also accept: string. |
| stroke corner adjustment | any | r/w | The corner adjustment applied to the find object preference. Can return: none/dashes/gaps/dashes and gaps or nothing. |
| stroke dash and gap | any | 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 | any | 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 | any | read | Transparency settings for the stroke. Can return: find change stroke transparency setting or nothing. |
| stroke type | any | r/w | The name of the stroke style to apply. Can return: stroke style or nothing. Can also accept: string. |
| stroke weight | any | r/w | The weight (in points) to apply to the find object preference’s stroke. Can return: number or string or nothing. |
| text column count | any | 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. |
| text column fixed width | any | r/w | The column width of the columns in the text frame. Can return: number or string (0 – 8640 points) or nothing. |
| text column gutter | any | r/w | The space between columns in the text frame. Can return: number or string (0 – 8640 points) or nothing. |
| text wrap mode | any | r/w | The text wrap mode. . Can return: none/jump object text wrap/next column text wrap/bounding box text wrap/contour or nothing. |
| text wrap offset | any | r/w | The minimum space between text and the edges of the wrapped object. Specify four values in the format [top, left, bottom, right]. . Can return: Ordered list containing top:number or string, left:number or string, bottom:number or string, right:number o… |
| text wrap side | any | r/w | Text wrap side options. Can return: both sides/left side/right side/side towards spine/side away from spine/largest area or nothing. |
| top crop | any | r/w | The amount in measurement units to crop the top edge of a graphic. Can return: number or string or nothing. |
| transparency settings | any | read | Transparency settings. Can return: find change transparency setting or nothing. |
| use custom baseline frame grid | any | r/w | If true, uses a custom baseline frame grid. Can return: boolean or nothing. |
| use fixed column width | any | 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. |
| user modified wrap | any | read | If true, the text wrap path has been explicitly modified by the user. Can return: boolean or nothing. |
| vertical justification | any | r/w | The vertical alignment of the text content. . Can return: top align/center align/bottom align/justify align or nothing. |
| vertical reference point | any | 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 | any | 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 … |