ObjectStyle

An object style.

ObjectStyle Properties

Property Type Access Description
anchoredObjectSettings AnchoredObjectSetting r/w Anchored object settings for the object.
appliedParagraphStyle ParagraphStyle, String r/w The applied paragraph style.
applyNextParagraphStyle Boolean r/w When applying the paragraph style use next paragraph style value.
basedOn Object, String r/w The object style this style is based on.
baselineFrameGridOptions BaselineFrameGridOption r/w Baseline frame grid options.
blendMode BlendMode enumeration r/w The blending mode applied to the object.
cornerEffect CornerEffects enumeration r/w The corner effect applied to the object.
cornerRadius Real r/w The corner effect radius applied to the object.
defaultFrameGridObjectStyle Object, String r/w The default frame grid object style.
defaultObjectStyle Object, String r/w The default object style.
defaultTextObjectStyle Object, String r/w The default text object style.
enableAnchoredObjectOptions Boolean r/w Enable the anchored object options category of object style.
enableDropshadowAndFeather Boolean r/w Enable the dropshadow and feather category of object style.
enableFill Boolean r/w Enable the fill category of object style.
enableParagraphStyle Boolean r/w Enable the paragraph style category of object style.
enableStoryOptions Boolean r/w Enable the story options category of object style.
enableStroke Boolean r/w Enable the stroke category of object style.
enableStrokeAndCornerEffects Boolean r/w Enable the stroke and corner effects category of object style.
enableTextFrameBaselineOptions Boolean r/w Enable the text frame baseline options category of object style.
enableTextFrameGeneralOptions Boolean r/w Enable the text frame general options category of object style.
enableTextWrapAndOthers Boolean r/w Enable the text wrap and others category of object style.
enableTransparency Boolean r/w Enable the transparency category of object style.
endCap EndCap enumeration r/w The end cap applied to the stroke of the object.
endJoin EndJoin enumeration r/w The end join applied to the stroke of the object.
featherCornerType FeatherCornerType enumeration r/w The type of feathering applied to the object.
featherMode FeatherMode enumeration r/w The feathering mode applied to the object.
featherNoise Real (0 – 100) r/w The amount of noise applied to the feathering applied to the object.
featherWidth Unit (0 – 1000 points) r/w The width of the feathering applied to the object.
fillColor Swatch, String r/w The fill of the object.
fillTint Real r/w The tint percentage applied to the fill of the object (-1 indicates 100%).
gapColor Swatch r/w The gap color applied to the stroke of the object.
gapTint Real r/w The tint applied to the gap color of the object (-1 indicates 100%).
gradientFillAngle Real r/w The angle of the gradient applied to the fill of the object.
gradientStrokeAngle Real r/w The angle of the gradient applied to the stroke of the object.
id Long read A unique number identifying the object.
index Long read Index of the object within its parent object.
isolateBlending Boolean r/w If true, the object will blend in isolation.
knockoutGroup 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.
leftLineEnd ArrowHead 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.
miterLimit Real 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.
opacity Real (0 – 100) r/w The opacity of the object.
overprintFill Boolean r/w If true, the fill of the object will overprint.
overprintGap Boolean r/w If true, the gap color applied to the stroke of the object will overprint.
overprintStroke Boolean r/w If true, the storke of the object will overprint.
parent Object read The parent of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
rightLineEnd ArrowHead 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.
shadowBlendMode BlendMode enumeration r/w The blending mode applied to the drop shadow.
shadowBlurRadius Unit (0 – 144 points) r/w The blur radius of the the drop shadow.
shadowColor Swatch r/w The color of the drop shadow.
shadowMode ShadowMode enumeration r/w The shadow mode of the drop shadow.
shadowNoise Real (0 – 100) r/w The amount of noise applied to the drop shadow.
shadowOpacity Real (0 – 100) r/w The opacity of the drop shadow.
shadowSpread Real (0 – 100) r/w The distance to spread the drop shadow before applying blurring.
shadowXOffset Unit (-1000 – 1000 points) r/w The horizontal offset of the drop shadow from the object.
shadowYOffset Unit (-1000 – 1000 points) r/w The vertical offset of the drop shadow from the object.
storyPreferences StoryPreference r/w Story preferences.
strokeAlignment StrokeAlignment enumeration r/w The stroke alignment of the object.
strokeColor Swatch, String r/w The stroke color of the object.
strokeCornerAdjustment StrokeCornerAdjustment enumeration r/w The adjustment method to apply to the corners of a dashed stroke.
strokeDashAndGap Array of Units r/w The dash and gap settings of a dashed stroke. A list of up to 6 values.
strokeTint Real r/w The tint percentage applied to the stroke (-1 indicates 100%).
strokeType StrokeStyle r/w The stroke type.
strokeWeight Unit r/w The stroke weight (thickness) of the stroke.
textFramePreferences TextFramePreference r/w Text frame preferences.
textWrapPreferences TextWrapPreference r/w Text wrap preferences for the object.

ObjectStyle Methods

Method Returns Description
duplicate Object Duplicates the object.
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel 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.
remove Nothing Delete the object.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: