Adobe InDesign CS5.5 Server (7.5) Object Model JS: DashedStrokeStyle

InDesign Server CS5.5

Class

DashedStrokeStyle

 A dashed stroke style. Base Class: StrokeStyle

QuickLinks

addEventListener, duplicate, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
StrokeStyle
DashedStrokeStyle
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
dashArrayArray of Measurement Unit (Number or String) r/wThe pattern of dashes and gaps, in the format [dash length1, gap length1, dash length2, gap length2]. Define up to ten values.
endCapEndCap:
EndCap.BUTT_END_CAP
EndCap.ROUND_END_CAP
EndCap.PROJECTING_END_CAP
r/wThe end shape of an open path.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the DashedStrokeStyle.
indexnumber readonlyThe index of the DashedStrokeStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the DashedStrokeStyle.
parentApplication
Document
readonlyThe parent of the DashedStrokeStyle (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
strokeCornerAdjustmentStrokeCornerAdjustment:
StrokeCornerAdjustment.NONE
StrokeCornerAdjustment.DASHES
StrokeCornerAdjustment.GAPS
StrokeCornerAdjustment.DASHES_AND_GAPS
r/wThe corner adjustment applied to the DashedStrokeStyle.
strokeStyleTypestring readonlyThe stroke style type.

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)

DashedStrokeStyle duplicate ()
Duplicates the DashedStrokeStyle.

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

void remove ([replacingWith: varies])
Deletes the stroke style.

ParameterTypeDescription
replacingWithString
StrokeStyle
The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional)

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 DashedStrokeStyle.

string toSpecifier ()
Retrieves the object specifier.

Used in:

DashedStrokeStyle DashedStrokeStyles.nextItem (obj: DashedStrokeStyle)

DashedStrokeStyle DashedStrokeStyles.previousItem (obj: DashedStrokeStyle)

Return

DashedStrokeStyle DashedStrokeStyle.duplicate ()

Array of DashedStrokeStyle DashedStrokeStyle.getElements ()

DashedStrokeStyle DashedStrokeStyles.[] (index: number)

DashedStrokeStyle DashedStrokeStyles.add ([withProperties: Object])

DashedStrokeStyle DashedStrokeStyles.anyItem ()

Array of DashedStrokeStyle DashedStrokeStyles.everyItem ()

DashedStrokeStyle DashedStrokeStyles.firstItem ()

DashedStrokeStyle DashedStrokeStyles.item (index: varies)

DashedStrokeStyle DashedStrokeStyles.itemByID (id: number)

DashedStrokeStyle DashedStrokeStyles.itemByName (name: string)

Array of DashedStrokeStyle DashedStrokeStyles.itemByRange (from: varies, to: varies)

DashedStrokeStyle DashedStrokeStyles.lastItem ()

DashedStrokeStyle DashedStrokeStyles.middleItem ()

DashedStrokeStyle DashedStrokeStyles.nextItem (obj: DashedStrokeStyle)

DashedStrokeStyle DashedStrokeStyles.previousItem (obj: DashedStrokeStyle)

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