Adobe InCopy CS5.5 (7.5) Object Model JS: PageItemDefault

InCopy CS5.5

Class

PageItemDefault

 Default page item formatting properties. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
PageItemDefault
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
bottomLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
readonlyThe end shape of an open path.
endJoinEndJoin:
EndJoin.MITER_END_JOIN
EndJoin.ROUND_END_JOIN
EndJoin.BEVEL_END_JOIN
readonlyThe corner join applied to the PageItemDefault.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
fillColorString
Swatch
readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItemDefault. . Can also accept: String.
fillTintnumber readonlyThe 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.)
gapColorSwatch readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTintnumber readonlyThe 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 readonlyThe angle of a linear gradient applied to the fill of the PageItemDefault. (Range: -180 to 180)
gradientStrokeAnglenumber readonlyThe 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
readonlyThe arrowhead applied to the start of the path.
miterLimitnumber (range: 1 - 500) readonlyThe limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
nonprintingbool readonlyIf true, the PageItemDefault does not print.
overprintFillbool readonlyIf true, the PageItemDefault's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGapbool readonlyIf true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStrokebool readonlyIf 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
readonlyThe arrowhead applied to the end of the path.
strokeAlignmentStrokeAlignment:
StrokeAlignment.CENTER_ALIGNMENT
StrokeAlignment.INSIDE_ALIGNMENT
StrokeAlignment.OUTSIDE_ALIGNMENT
readonlyThe stroke alignment applied to the PageItemDefault.
strokeColorString
Swatch
readonlyThe swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault. Can also accept: String.
strokeTintnumber readonlyThe 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.)
strokeTypeString
StrokeStyle
readonlyThe name of the stroke style to apply. Can also accept: String.
strokeWeightMeasurement Unit (Number or String) readonlyThe weight (in points) to apply to the PageItemDefault's stroke.
topLeftCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe 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.
topLeftCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
topRightCornerOptionCornerOptions:
CornerOptions.NONE
CornerOptions.ROUNDED_CORNER
CornerOptions.INVERSE_ROUNDED_CORNER
CornerOptions.INSET_CORNER
CornerOptions.BEVEL_CORNER
CornerOptions.FANCY_CORNER
readonlyThe shape to apply to the top right corner of rectangular shapes
topRightCornerRadiusMeasurement Unit (Number or String) readonlyThe radius in measurement units of the corner effect applied to the top right corner of rectangular shapes

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.pageItemDefaults

Document.pageItemDefaults

Return

Array of PageItemDefault PageItemDefault.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index