Adobe InDesign CS4 (6.0) Object Model JS: PageItemDefault

InDesign CS4

Class

PageItemDefault

 Default page item formatting properties. Base Class: Preference

QuickLinks

applyObjectStyle, clearObjectStyleOverrides, getElements, toSource, toSpecifier

Hierarchy

Application | Document
Preference
PageItemDefault
ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting

Properties

PropertyTypeAccessDescription
appliedGraphicObjectStyleObjectStyleString r/wThe default graphic object style applied to the PageItemDefault. Can also accept: String.
appliedGridObjectStyleObjectStyle
String
r/wThe default frame grid object style applied to the PageItemDefault. Can also accept: String.
appliedTextObjectStyleObjectStyle
String
r/wThe default text object style applied to the PageItemDefault. Can also accept: String.
contentTransparencySettingsContentTransparencySetting readonlyTransparency settings for the content of the PageItemDefault.
cornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
r/wThe shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadiusMeasurement Unit (Number or String) r/wThe radius in measurement units of the corner effect.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
r/wThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
r/wThe corner join applied to the PageItemDefault.
fillColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItemDefault. . Can also accept: String.
fillTintnumber r/wThe 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.)
fillTransparencySettingsFillTransparencySetting readonlyTransparency settings for the fill applied to the PageItemDefault.
gapColorSwatch r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber r/wThe 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.)
gradientFillAnglenumber r/wThe angle of a linear gradient applied to the fill of the PageItemDefault. (Range: -180 to 180)
gradientStrokeAnglenumber r/wThe angle of a linear gradient applied to the stroke of the PageItemDefault. (Range: -180 to 180)
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
leftLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the start of the path.
miterLimitnumber (range: 1 - 500) r/wThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
nonprintingbool r/wIf true, the PageItemDefault does not print.
overprintFillbool r/wIf true, the PageItemDefault's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool r/wIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool r/wIf true, the PageItemDefault's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
parentApplication
Document
readonlyThe parent of the PageItemDefault (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
rightLineEndArrowHead:
ArrowHead.NONE
ArrowHead.SIMPLE_ARROW_HEAD
ArrowHead.SIMPLE_WIDE_ARROW_HEAD
ArrowHead.TRIANGLE_ARROW_HEAD
ArrowHead.TRIANGLE_WIDE_ARROW_HEAD
ArrowHead.BARBED_ARROW_HEAD
ArrowHead.CURVED_ARROW_HEAD
ArrowHead.CIRCLE_ARROW_HEAD
ArrowHead.CIRCLE_SOLID_ARROW_HEAD
ArrowHead.SQUARE_ARROW_HEAD
ArrowHead.SQUARE_SOLID_ARROW_HEAD
ArrowHead.BAR_ARROW_HEAD
r/wThe arrowhead applied to the end of the path.
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
r/wThe stroke alignment applied to the PageItemDefault.
strokeColorString
Swatch
r/wThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault. Can also accept: String.
strokeTintnumber r/wThe 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.)
strokeTransparencySettingsStrokeTransparencySetting readonlyTransparency settings for the stroke.
strokeTypeString
StrokeStyle
r/wThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) r/wThe weight (in points) to apply to the PageItemDefault's stroke.
transparencySettingsTransparencySetting readonlyTransparency settings.

Methods

Instances

void applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Applies the specified object style.

ParameterTypeDescription
usingObjectStyleThe object style to apply.
clearingOverridesboolIf true, clears the PageItemDefault's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyleboolIf true, clears attributes and formatting applied to the PageItemDefault that are not defined in the object style. (Optional) (default: false)

void clearObjectStyleOverrides ()
Clear overrides for object style

Array of PageItemDefault getElements ()
Resolves the object specifier, creating an array of object references.

string toSource ()
Generates a string which, if executed, will return the PageItemDefault.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.pageItemDefaults

ContentTransparencySetting.parent

Document.pageItemDefaults

FillTransparencySetting.parent

StrokeTransparencySetting.parent

TransparencySetting.parent

Return

Array of PageItemDefault PageItemDefault.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index