ObjectStyle
An object style.
Instance
Read Only
ObjectExportOption objectExportOptions
Export options for the object
Read Only
TransparencySetting transparencySettings
Transparency settings.
Read Only
StrokeTransparencySetting strokeTransparencySettings
Transparency settings for the stroke.
Read Only
FillTransparencySetting fillTransparencySettings
Transparency settings for the fill applied to the ObjectStyle.
Read Only
ContentTransparencySetting contentTransparencySettings
Transparency settings for the content of the ObjectStyle.
Read Only
ObjectStyleObjectEffectsCategorySettings objectEffectsEnablingSettings
The object effects enabling settings.
Read Only
ObjectStyleStrokeEffectsCategorySettings strokeEffectsEnablingSettings
The stroke effects enabling settings.
Read Only
ObjectStyleFillEffectsCategorySettings fillEffectsEnablingSettings
The fill effects enabling settings.
Read Only
ObjectStyleContentEffectsCategorySettings contentEffectsEnablingSettings
The content effects enabling settings.
Read Only
Number id
The unique ID of the ObjectStyle.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Mixed parent
The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup).
Read Only
Number index
The index of the ObjectStyle within its containing object.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
Read Only
ObjectStyleExportTagMaps objectStyleExportTagMaps
A collection of object style export tag maps.
Read Only
Preferences preferences
A collection of preferences objects.
Boolean emitCss
Emit CSS
TransformAttributeOption transformAttributeOptions
The layout attribute options to apply to any page item.
Boolean enableTransformAttributes
If true, enables the Dimension and Position attributes
Boolean includeClass
If true, class attribute will be generated for the style
Boolean enableTextFrameAutoSizingOptions
If true, the object style will apply auto-sizing text frame options.
Boolean enableTextFrameColumnRuleOptions
Enable the text frame column rule options category of object style
Boolean enableExportTagging
If true, the object style will apply an epub tag and class.
Boolean enableObjectExportAltTextOptions
If true, the object style will apply alt text export options.
Boolean enableObjectExportTaggedPdfOptions
If true, the object style will apply tagged pdf export options.
Boolean enableObjectExportEpubOptions
If true, the object style will apply epub export options.
Mixed basedOn
The style that this style is based on. Can return: ObjectStyle or String.
String name
The name of the ObjectStyle.
ParagraphStyle appliedParagraphStyle
The paragraph style applied to the text. Can also accept: String.
Boolean applyNextParagraphStyle
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).
Boolean enableFill
If true, the object style will apply a fill.
Boolean enableStroke
If true, the object style will apply a stroke.
Boolean enableParagraphStyle
If true, the object style will apply a paragraph style.
Boolean enableTextFrameGeneralOptions
If true, the object style will apply general text frame options.
Boolean enableTextFrameBaselineOptions
If true, the object style will apply baseline text frame options.
Boolean enableStoryOptions
If true, the object style will apply story options.
Boolean enableTextWrapAndOthers
If true, the object style will apply text wrap, contour, and non-printing settings.
Boolean enableAnchoredObjectOptions
If true, the object style will apply an anchored object setting.
Swatch fillColor
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String.
Number fillTint
The percent of tint to use in the ObjectStyle'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.)
Boolean overprintFill
If true, the ObjectStyle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
Measurement Unit (Number or String)=any strokeWeight
The weight (in points) to apply to the ObjectStyle's stroke.
Number miterLimit
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
EndCap endCap
The end shape of an open path.
EndJoin endJoin
The corner join applied to the ObjectStyle.
StrokeStyle strokeType
The name of the stroke style to apply. Can also accept: String.
ArrowHead leftLineEnd
The arrowhead applied to the start of the path.
ArrowHead rightLineEnd
The arrowhead applied to the end of the path.
Swatch strokeColor
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String.
Number strokeTint
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.)
Boolean overprintStroke
If true, the ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
Swatch gapColor
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
Number gapTint
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.)
Boolean overprintGap
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
StrokeAlignment strokeAlignment
The stroke alignment applied to the ObjectStyle.
Boolean nonprinting
If true, the ObjectStyle does not print.
Number gradientFillAngle
The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180)
Number gradientStrokeAngle
The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180)
TextFramePreference textFramePreferences
Text frame preference settings.
BaselineFrameGridOption baselineFrameGridOptions
Baseline frame grid option settings.
AnchoredObjectSetting anchoredObjectSettings
Anchored object settings.
TextWrapPreference textWrapPreferences
The text wrap preference properties that define the default formatting for wrapping text around objects.
StoryPreference storyPreferences
Story preference settings.
CornerOptions topLeftCornerOption
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
CornerOptions topRightCornerOption
The shape to apply to the top right corner of rectangular shapes
CornerOptions bottomLeftCornerOption
The shape to apply to the bottom left corner of rectangular shapes.
CornerOptions bottomRightCornerOption
The shape to apply to the bottom right corner of rectangular shapes.
Measurement Unit (Number or String)=any topLeftCornerRadius
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
Measurement Unit (Number or String)=any topRightCornerRadius
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
Measurement Unit (Number or String)=any bottomLeftCornerRadius
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
Measurement Unit (Number or String)=any bottomRightCornerRadius
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
FrameFittingOption frameFittingOptions
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.
Boolean enableFrameFittingOptions
If true, the object style will apply frame fitting options.
Boolean enableStrokeAndCornerOptions
If true, the object style will apply stroke options and corner options.
ArrowHeadAlignmentEnum arrowHeadAlignment
The arrowhead alignment applied to the ObjectStyle.
Number leftArrowHeadScale
The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000)
Number rightArrowHeadScale
The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000)
Boolean enableTextFrameFootnoteOptions
Enable the text frame footnote options category of object style
String label
A property that can be set to any string.
Object properties
A property that allows setting of several properties at the same time.
Methods
Boolean setDimensionAttributeState( DimensionAttributes whichAttributes, Boolean attributeState )
Sets the given dimension attribute state to enabled or disabled state
Parameters
Type Name Description
Boolean setPositionAttributeState( PositionAttributes whichAttributes, Boolean attributeState )
Sets the given position attribute state to enabled or disabled state
Parameters
Type Name Description
ObjectStyle duplicate()
Duplicates the ObjectStyle.
ObjectStyle move( LocationOptions to, Mixed reference )
Moves the ObjectStyle to the specified location.
Parameters
Type Name Description
remove( ObjectStyle replacingWith )
Deletes the style.
Parameters
Type Name Description
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the ObjectStyle.
ObjectStyle getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description