K4 InDesign Javascript API Documentation

PreferencesPageItemDefault

Default page item formatting properties.

Extends

Instance Properties

Name Description Access
appliedGraphicObjectStyle ObjectStyle The default graphic object style applied to the PageItemDefault. Can also accept: String. read-write
appliedGridObjectStyle ObjectStyle The default frame grid object style applied to the PageItemDefault. Can also accept: String. read-write
appliedTextObjectStyle ObjectStyle The default text object style applied to the PageItemDefault. Can also accept: String. read-write
arrowHeadAlignment ArrowHeadAlignmentEnum The arrowhead alignment applied to the PageItemDefault. 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
contentTransparencySettings ContentTransparencySetting Transparency settings for the content of the PageItemDefault. read-only
endCap EndCap The end shape of an open path. read-write
endJoin EndJoin The corner join applied to the PageItemDefault. 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 PageItemDefault. . Can also accept: String. read-write
fillTint number The percent of tint to use in the PageItemDefault'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 PageItemDefault. read-only
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 PageItemDefault. (Range: -180 to 180) read-write
gradientStrokeAngle number The angle of a linear gradient applied to the stroke of the PageItemDefault. (Range: -180 to 180) read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
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
nonprinting bool If true, the PageItemDefault does not print. read-write
overprintFill bool If true, the PageItemDefault'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 PageItemDefault's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. read-write
parent The parent of the PageItemDefault (a Application or Document). 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
strokeAlignment StrokeAlignment The stroke alignment applied to the PageItemDefault. read-write
strokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault. Can also accept: String. read-write
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 PageItemDefault's stroke. 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
transparencySettings TransparencySetting Transparency settings. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
applyObjectStyle(
using ​[, clearingOverrides] ​[, clearingOverridesThroughRootObjectStyle])
clearObjectStyleOverrides(
)
getElements(
)
  → PageItemDefault
removeEventListener(
eventType, handler ​[, captures])
  → 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)
applyObjectStyle(
using ​[, clearingOverrides=true] ​[, clearingOverridesThroughRootObjectStyle=false])
Applies the specified object style.
using ObjectStyle The object style to apply.
clearingOverrides bool If true, clears the PageItemDefault's existing attributes before applying the style. (Optional)
clearingOverridesThroughRootObjectStyle bool If true, clears attributes and formatting applied to the PageItemDefault that are not defined in the object style. (Optional)
clearObjectStyleOverrides(
)
Clear overrides for object style
getElements(
)
  → PageItemDefault
Resolves the object specifier, creating an array of object references.
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)
toSource(
)
  → string
Generates a string which, if executed, will return the PageItemDefault.
toSpecifier(
)
  → string
Retrieves the object specifier.