Adobe InDesign CS6 Server (8.0) Object Model JS: DottedStrokeStyle

InDesign Server CS6

Class

DottedStrokeStyle

 A dotted stroke style. Base Class: StrokeStyle

QuickLinks

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

Hierarchy

Application | Document
StrokeStyle
DottedStrokeStyle
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
dotArrayArray of Measurement Unit (Number or String) r/wThe length of gaps between dots. Define up to five values.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the DottedStrokeStyle.
indexnumber readonlyThe index of the DottedStrokeStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the DottedStrokeStyle.
parentApplicationDocument readonlyThe parent of the DottedStrokeStyle (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 DottedStrokeStyle.
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)

DottedStrokeStyle duplicate ()
Duplicates the DottedStrokeStyle.

Array of DottedStrokeStyle 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 DottedStrokeStyle.

string toSpecifier ()
Retrieves the object specifier.

Used in:

DottedStrokeStyle DottedStrokeStyles.nextItem (obj: DottedStrokeStyle)

DottedStrokeStyle DottedStrokeStyles.previousItem (obj: DottedStrokeStyle)

Return

DottedStrokeStyle DottedStrokeStyle.duplicate ()

Array of DottedStrokeStyle DottedStrokeStyle.getElements ()

DottedStrokeStyle DottedStrokeStyles.[] (index: number)

DottedStrokeStyle DottedStrokeStyles.add ([withProperties: Object])

DottedStrokeStyle DottedStrokeStyles.anyItem ()

Array of DottedStrokeStyle DottedStrokeStyles.everyItem ()

DottedStrokeStyle DottedStrokeStyles.firstItem ()

DottedStrokeStyle DottedStrokeStyles.item (index: varies)

DottedStrokeStyle DottedStrokeStyles.itemByID (id: number)

DottedStrokeStyle DottedStrokeStyles.itemByName (name: string)

Array of DottedStrokeStyle DottedStrokeStyles.itemByRange (from: varies, to: varies)

DottedStrokeStyle DottedStrokeStyles.lastItem ()

DottedStrokeStyle DottedStrokeStyles.middleItem ()

DottedStrokeStyle DottedStrokeStyles.nextItem (obj: DottedStrokeStyle)

DottedStrokeStyle DottedStrokeStyles.previousItem (obj: DottedStrokeStyle)

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