object style

An object style.

object style properties

Property Type Access Description
anchored object settings anchored object setting r/w Anchored object settings for the object.
applied paragraph style paragraph style, string r/w The applied paragraph style.
apply next paragraph style boolean r/w When applying the paragraph style use next paragraph style value.
based on object, string r/w The object style this style is based on.
baseline frame grid options baseline frame grid option r/w Baseline frame grid options.
blend mode blend mode enumeration r/w The blending mode applied to the object.
class integer read The class descriptor type.
corner effect corner effects enumeration r/w The corner effect applied to the object.
corner radius fixed r/w The corner effect radius applied to the object.
default frame grid object style object, string r/w The default frame grid object style.
default object style object, string r/w The default object style.
default text object style object, string r/w The default text object style.
enable anchored object options boolean r/w Enable the anchored object options category of object style.
enable dropshadow and feather boolean r/w Enable the dropshadow and feather category of object style.
enable fill boolean r/w Enable the fill category of object style.
enable paragraph style boolean r/w Enable the paragraph style category of object style.
enable story options boolean r/w Enable the story options category of object style.
enable stroke boolean r/w Enable the stroke category of object style.
enable stroke and corner effects boolean r/w Enable the stroke and corner effects category of object style.
enable text frame baseline options boolean r/w Enable the text frame baseline options category of object style.
enable text frame general options boolean r/w Enable the text frame general options category of object style.
enable text wrap and others boolean r/w Enable the text wrap and others category of object style.
enable transparency boolean r/w Enable the transparency category of object style.
end cap end cap enumeration r/w The end cap applied to the stroke of the object.
end join end join enumeration r/w The end join applied to the stroke of the object.
feather corner type feather corner type enumeration r/w The type of feathering applied to the object.
feather mode feather mode enumeration r/w The feathering mode applied to the object.
feather noise fixed (0 – 100) r/w The amount of noise applied to the feathering applied to the object.
feather width number or string (0 – 1000 points) r/w The width of the feathering applied to the object.
fill color swatch, string r/w The fill of the object.
fill tint fixed r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
gap color swatch r/w The gap color applied to the stroke of the object.
gap tint fixed r/w The tint applied to the gap color of the object (-1 indicates 100%).
gradient fill angle fixed r/w The angle of the gradient applied to the fill of the object.
gradient stroke angle fixed r/w The angle of the gradient applied to the stroke of the object.
id integer read A unique number identifying the object.
index integer read Index of the object within its parent object.
isolate blending boolean r/w If true, the object will blend in isolation.
knockout group boolean r/w If true, the object will blend as a knockout group.
label string r/w A label that can be set to any string.
left line end arrow head enumeration r/w A shape, such as an arrowhead, applied to the left end of the paths of the object. This
shape will only appear on open paths.
miter limit fixed r/w The point at which the rendering of a corner point switches from a miter join to a
bevel join.
name string r/w The name of the object.
nonprinting boolean r/w If true, the object is non-printing.
object reference object read An object reference for this object.
opacity fixed (0 – 100) r/w The opacity of the object.
overprint fill boolean r/w If true, the fill of the object will overprint.
overprint gap boolean r/w If true, the gap color applied to the stroke of the object will overprint.
overprint stroke boolean r/w If true, the storke of the object will overprint.
parent object read The parent of the object.
properties record r/w Property that allows setting of several properties at the same time.
right line end arrow head enumeration r/w A shape, such as an arrowhead, applied the right end of the paths of the object. This
shape will only appear on open paths.
shadow blend mode blend mode enumeration r/w The blending mode applied to the drop shadow.
shadow blur radius number or string (0 – 144 points) r/w The blur radius of the the drop shadow.
shadow color swatch r/w The color of the drop shadow.
shadow mode shadow mode enumeration r/w The shadow mode of the drop shadow.
shadow noise fixed (0 – 100) r/w The amount of noise applied to the drop shadow.
shadow opacity fixed (0 – 100) r/w The opacity of the drop shadow.
shadow spread fixed (0 – 100) r/w The distance to spread the drop shadow before applying blurring.
shadow x offset number or string (-1000 – 1000 points) r/w The horizontal offset of the drop shadow from the object.
shadow y offset number or string (-1000 – 1000 points) r/w The vertical offset of the drop shadow from the object.
story preferences story preference r/w Story preferences.
stroke alignment stroke alignment enumeration r/w The stroke alignment of the object.
stroke color swatch, string r/w The stroke color of the object.
stroke corner adjustment stroke corner adjustment enumeration r/w The adjustment method to apply to the corners of a dashed stroke.
stroke dash and gap list of numbers or strings r/w The dash and gap settings of a dashed stroke. A list of up to 6 values.
stroke tint fixed r/w The tint percentage applied to the stroke (-1 indicates 100%).
stroke type stroke style r/w The stroke type.
stroke weight number or string r/w The stroke weight (thickness) of the stroke.
text frame preferences text frame preference r/w Text frame preferences.
text wrap preferences text wrap preference r/w Text wrap preferences for the object.

object style methods

Method Returns Description
delete Nothing Delete the object.
duplicate object Duplicates the object.
extract label string Gets the content of the label associated with the specified key (name).
insert label Nothing Sets the content of the label associated with the specified key (name), creating the
label if it does not already exist.
move object Moves the object.

Leave a Comment

Previous post:

Next post: