K4 InDesign Javascript API Documentation

Stroke StylesStripedStrokeStyle

A striped stroke style.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the StripedStrokeStyle. read-only
index number The index of the StripedStrokeStyle within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the StripedStrokeStyle. read-write
parent The parent of the StripedStrokeStyle (a Document or Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
stripeArray number The 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). read-write
strokeStyleType string The stroke style type. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → StripedStrokeStyle
getElements(
)
  → StripedStrokeStyle
remove(
replacingWith)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → StripedStrokeStyle
Duplicates the StripedStrokeStyle.
getElements(
)
  → StripedStrokeStyle
Resolves the object specifier, creating an array of object references.
remove(
replacingWith)
Deletes the stroke style.
replacingWith The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the StripedStrokeStyle.
toSpecifier(
)
  → string
Retrieves the object specifier.