K4 InDesign Javascript API Documentation

Object StylesObjectStyle

An object style.

Instance Properties

Name Description Access
anchoredObjectSettings AnchoredObjectSetting Anchored object settings. read-write
appliedParagraphStyle ParagraphStyle The paragraph style applied to the text. Can also accept: String. read-write
applyNextParagraphStyle bool 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). read-write
arrowHeadAlignment ArrowHeadAlignmentEnum The arrowhead alignment applied to the ObjectStyle. read-write
basedOn The style that this style is based on. Can return: ObjectStyle or String. read-write
baselineFrameGridOptions BaselineFrameGridOption Baseline frame grid option settings. read-write
bottomLeftCornerOption CornerOptions The shape to apply to the bottom left corner of rectangular shapes. read-write
bottomLeftCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes read-write
bottomRightCornerOption CornerOptions The shape to apply to the bottom right corner of rectangular shapes. read-write
bottomRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes read-write
contentEffectsEnablingSettings ObjectStyleContentEffectsCategorySettings The content effects enabling settings. read-only
contentTransparencySettings ContentTransparencySetting Transparency settings for the content of the ObjectStyle. read-only
emitCss bool Emit CSS read-write
enableAnchoredObjectOptions bool If true, the object style will apply an anchored object setting. read-write
enableExportTagging bool If true, the object style will apply an epub tag and class. read-write
enableFill bool If true, the object style will apply a fill. read-write
enableFrameFittingOptions bool If true, the object style will apply frame fitting options. read-write
enableObjectExportAltTextOptions bool If true, the object style will apply alt text export options. read-write
enableObjectExportEpubOptions bool If true, the object style will apply epub export options. read-write
enableObjectExportTaggedPdfOptions bool If true, the object style will apply tagged pdf export options. read-write
enableParagraphStyle bool If true, the object style will apply a paragraph style. read-write
enableStoryOptions bool If true, the object style will apply story options. read-write
enableStroke bool If true, the object style will apply a stroke. read-write
enableStrokeAndCornerOptions bool If true, the object style will apply stroke options and corner options. read-write
enableTextFrameAutoSizingOptions bool If true, the object style will apply auto-sizing text frame options. read-write
enableTextFrameBaselineOptions bool If true, the object style will apply baseline text frame options. read-write
enableTextFrameFootnoteOptions bool Enable the text frame footnote options category of object style read-write
enableTextFrameGeneralOptions bool If true, the object style will apply general text frame options. read-write
enableTextWrapAndOthers bool If true, the object style will apply text wrap, contour, and non-printing settings. read-write
enableTransformAttributes bool If true, enables the Dimension and Position attributes read-write
endCap EndCap The end shape of an open path. read-write
endJoin EndJoin The corner join applied to the ObjectStyle. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fillColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String. read-write
fillEffectsEnablingSettings ObjectStyleFillEffectsCategorySettings The fill effects enabling settings. read-only
fillTint number 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.) read-write
fillTransparencySettings FillTransparencySetting Transparency settings for the fill applied to the ObjectStyle. read-only
frameFittingOptions FrameFittingOption 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. read-write
gapColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. read-write
gapTint number 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.) read-write
gradientFillAngle number The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180) read-write
gradientStrokeAngle number The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180) read-write
id number The unique ID of the ObjectStyle. read-only
includeClass bool If true, class attribute will be generated for the style read-write
index number The index of the ObjectStyle within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
leftArrowHeadScale number The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000) read-write
leftLineEnd ArrowHead The arrowhead applied to the start of the path. read-write
miterLimit = 4 number The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. read-write
name string The name of the ObjectStyle. read-write
nonprinting bool If true, the ObjectStyle does not print. read-write
objectEffectsEnablingSettings ObjectStyleObjectEffectsCategorySettings The object effects enabling settings. read-only
objectExportOptions ObjectExportOption Export options for the object read-only
objectStyleExportTagMaps ObjectStyleExportTagMaps A collection of object style export tag maps. read-only
overprintFill bool If true, the ObjectStyle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. read-write
overprintGap bool If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. read-write
overprintStroke bool If true, the ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. read-write
parent The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup). read-only
preferences Preferences A collection of preferences objects. read-only
properties Object A property that allows setting of several properties at the same time. read-write
rightArrowHeadScale number The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000) read-write
rightLineEnd ArrowHead The arrowhead applied to the end of the path. read-write
storyPreferences StoryPreference Story preference settings. read-write
strokeAlignment StrokeAlignment The stroke alignment applied to the ObjectStyle. read-write
strokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String. read-write
strokeEffectsEnablingSettings ObjectStyleStrokeEffectsCategorySettings The stroke effects enabling settings. read-only
strokeTint number 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.) read-write
strokeTransparencySettings StrokeTransparencySetting Transparency settings for the stroke. read-only
strokeType StrokeStyle The name of the stroke style to apply. Can also accept: String. read-write
strokeWeight Measurement Unit (Number or String)=any The weight (in points) to apply to the ObjectStyle's stroke. read-write
textFrameFootnoteOptions TextFrameFootnoteOptionsObject Text frame footnote options settings. read-write
textFramePreferences TextFramePreference Text frame preference settings. read-write
textWrapPreferences TextWrapPreference The text wrap preference properties that define the default formatting for wrapping text around objects. read-write
topLeftCornerOption CornerOptions 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. read-write
topLeftCornerRadius Measurement Unit (Number or String)=any 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 read-write
topRightCornerOption CornerOptions The shape to apply to the top right corner of rectangular shapes read-write
topRightCornerRadius Measurement Unit (Number or String)=any The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes read-write
transformAttributeOptions TransformAttributeOption The layout attribute options to apply to any page item. read-write
transparencySettings TransparencySetting Transparency settings. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → ObjectStyle
extractLabel(
key)
  → string
getElements(
)
  → ObjectStyle
insertLabel(
key, value)
move(
to, reference)
  → ObjectStyle
remove(
[replacingWith])
removeEventListener(
eventType, handler ​[, captures])
  → bool
setDimensionAttributeState(
whichAttributes, attributeState)
  → bool
setPositionAttributeState(
whichAttributes, attributeState)
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → ObjectStyle
Duplicates the ObjectStyle.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → ObjectStyle
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
move(
to, reference)
  → ObjectStyle
Moves the ObjectStyle to the specified location.
to LocationOptions The new location relative to the reference object or within the container object.
reference The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional)
remove(
[replacingWith])
Deletes the style.
replacingWith ObjectStyle The style to apply in place of the deleted style. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
setDimensionAttributeState(
whichAttributes, attributeState)
  → bool
Sets the given dimension attribute state to enabled or disabled state
whichAttributes DimensionAttributes Which dimension attributes do you want to enable or disable.
attributeState bool Attribute state to be set, set true to enable and false to disable the attributes
setPositionAttributeState(
whichAttributes, attributeState)
  → bool
Sets the given position attribute state to enabled or disabled state
whichAttributes PositionAttributes Which position attributes do you want to enable or disable.
attributeState bool Attribute state to be set, set true to enable and false to disable the attributes
toSource(
)
  → string
Generates a string which, if executed, will return the ObjectStyle.
toSpecifier(
)
  → string
Retrieves the object specifier.