Adobe InDesign CS6 (8.0) Object Model JS: StripedStrokeStyle

InDesign CS6

Class

StripedStrokeStyle

 A striped stroke style. Base Class: StrokeStyle

QuickLinks

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

Hierarchy

Application | Document
StrokeStyle
StripedStrokeStyle
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the StripedStrokeStyle.
indexnumber readonlyThe index of the StripedStrokeStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the StripedStrokeStyle.
parentApplicationDocument readonlyThe parent of the StripedStrokeStyle (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
stripeArrayArray of number r/wThe width and position of stripes in a striped stroke pattern. Each stripe is specified by a start-end pair in the format [start1, end1, start2, end2]; each value indicates a percentage of the stroke weight. Each value must be greater than the previous value. (Range: 0 to 100).
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)

StripedStrokeStyle duplicate ()
Duplicates the StripedStrokeStyle.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

StripedStrokeStyle StripedStrokeStyles.nextItem (obj: StripedStrokeStyle)

StripedStrokeStyle StripedStrokeStyles.previousItem (obj: StripedStrokeStyle)

Return

StripedStrokeStyle StripedStrokeStyle.duplicate ()

Array of StripedStrokeStyle StripedStrokeStyle.getElements ()

StripedStrokeStyle StripedStrokeStyles.[] (index: number)

StripedStrokeStyle StripedStrokeStyles.add ([withProperties: Object])

StripedStrokeStyle StripedStrokeStyles.anyItem ()

Array of StripedStrokeStyle StripedStrokeStyles.everyItem ()

StripedStrokeStyle StripedStrokeStyles.firstItem ()

StripedStrokeStyle StripedStrokeStyles.item (index: varies)

StripedStrokeStyle StripedStrokeStyles.itemByID (id: number)

StripedStrokeStyle StripedStrokeStyles.itemByName (name: string)

Array of StripedStrokeStyle StripedStrokeStyles.itemByRange (from: varies, to: varies)

StripedStrokeStyle StripedStrokeStyles.lastItem ()

StripedStrokeStyle StripedStrokeStyles.middleItem ()

StripedStrokeStyle StripedStrokeStyles.nextItem (obj: StripedStrokeStyle)

StripedStrokeStyle StripedStrokeStyles.previousItem (obj: StripedStrokeStyle)

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