A collection of object styles.
object style Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchored object settings | anchored object setting | r/w | Anchored object settings. |
| applied paragraph style | paragraph style | r/w | The paragraph style applied to the text. Can also accept: string. |
| apply next paragraph style | boolean | r/w | If true, applies paragraph styles using Next Paragraph Style settings, beginning with the Next Paragraph Style defined in the paragraph style associated with the object style (if any). |
| based on | any | r/w | The style that this style is based on. Can return: object style or string. |
| baseline frame grid options | baseline frame grid option | r/w | Baseline frame grid option settings. |
| class | type | read | The class descriptor type. |
| content effects enabling settings | object style content effects category settings | read | The content effects enabling settings. |
| content transparency settings | content transparency setting | read | Transparency settings for the content of the object style. |
| corner option | none, rounded corner, inverse rounded corner, inset corner, bevel corner, fancy corner, none, rounded corner, inverse rounded corner, inset corner, bevel corner, fancy corner, none, rounded corner, inverse rounded corner, inset corner, bevel corner, fancy corner, none, rounded corner, inverse rounded corner, inset corner, bevel corner, fancy corner, none, rounded corner, inverse rounded corner, inset corner, bevel corner, fancy corner, |
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. |
| corner radius | number | r/w | The radius in measurement units of the corner effect. |
| enable anchored object options | boolean | r/w | If true, the object style will apply an anchored object setting. |
| enable fill | boolean | r/w | If true, the object style will apply a fill. |
| enable frame fitting options | boolean | r/w | If true, the object style will apply frame fitting options. |
| enable paragraph style | boolean | r/w | If true, the object style will apply a paragraph style. |
| enable story options | boolean | r/w | If true, the object style will apply story options. |
| enable stroke | boolean | r/w | If true, the object style will apply a stroke. |
| enable stroke and corner options | boolean | r/w | If true, the object style will apply stroke options and corner options. |
| enable text frame baseline options | boolean | r/w | If true, the object style will apply baseline text frame options. |
| enable text frame general options | boolean | r/w | If true, the object style will apply general text frame options. |
| enable text wrap and others | boolean | r/w | If true, the object style will apply text wrap, contour, and non-printing settings. |
| end cap | butt end cap, round end cap, projecting end cap, butt end cap, round end cap, projecting end cap, butt end cap, round end cap, projecting end cap, butt end cap, round end cap, projecting end cap, butt end cap, round end cap, projecting end cap, butt end cap, round end cap, projecting end cap, |
r/w | The end shape of an open path. |
| end join | miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, miter end join, round end join, bevel end join, |
r/w | The corner join applied to the object style. |
| fill color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object style. . Can also accept: string. |
| fill effects enabling settings | object style fill effects category settings | read | The fill effects enabling settings. |
| fill tint | real | r/w | The percent of tint to use in the object style’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.) |
| fill transparency settings | fill transparency setting | read | Transparency settings for the fill applied to the object style. |
| frame fitting options | frame fitting option | r/w | The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. |
| gap color | swatch | 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. |
| gap tint | real | 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.) |
| gradient fill angle | real | r/w | The angle of a linear gradient applied to the fill of the object style. (Range: -180 to 180) |
| gradient stroke angle | real | r/w | The angle of a linear gradient applied to the stroke of the object style. (Range: -180 to 180) |
| id | integer | read | The unique ID of the object style. |
| index | integer | read | The index of the object style within its containing object. |
| label | text | r/w | A property that can be set to any string. |
| left line end | 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, |
r/w | The arrowhead applied to the start of the path. |
| miter limit | real | 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). |
| name | text | r/w | The name of the object style. |
| nonprinting | boolean | r/w | If true, the object style does not print. |
| object effects enabling settings | object style object effects category settings | read | The object effects enabling settings. |
| object reference | object style | read | An object reference for the object. |
| overprint fill | boolean | r/w | If true, the object style’s fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
| overprint gap | boolean | r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
| overprint stroke | boolean | r/w | If true, the object style’s stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
| parent | specifier | read | The parent of the object style (a document, application or object style group). Can return: document, application or object style group. |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| right line end | 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, 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 solid arrow head, bar arrow head, |
r/w | The arrowhead applied to the end of the path. |
| story preferences | story preference | r/w | Story preference settings. |
| stroke alignment | center alignment, inside alignment, outside alignment, center alignment, inside alignment, outside alignment, center alignment, inside alignment, outside alignment, center alignment, inside alignment, outside alignment, center alignment, inside alignment, outside alignment, |
r/w | The stroke alignment applied to the object style. |
| stroke color | swatch | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the object style. Can also accept: string. |
| stroke corner adjustment | none, dashes, gaps, dashes and gaps, none, dashes, gaps, dashes and gaps, none, dashes, gaps, dashes and gaps, none, dashes, gaps, dashes and gaps, none, dashes, gaps, dashes and gaps, none, dashes, gaps, dashes and gaps, |
r/w | The corner adjustment applied to the object style. |
| stroke dash and gap | List of | 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]. |
| stroke effects enabling settings | object style stroke effects category settings | read | The stroke effects enabling settings. |
| stroke tint | real | 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.) |
| stroke transparency settings | stroke transparency setting | read | Transparency settings for the stroke. |
| stroke type | stroke style | r/w | The name of the stroke style to apply. Can also accept: string. |
| stroke weight | number | r/w | The weight (in points) to apply to the object style’s stroke. |
| text frame preferences | text frame preference | r/w | Text frame preference settings. |
| text wrap preferences | text wrap preference | r/w | The text wrap preference properties that define the default formatting for wrapping text around objects. |
| transparency settings | transparency setting | read | Transparency settings. |