K4 InDesign Javascript API Documentation

Stroke StylesDashedStrokeStyles

A collection of dashed stroke styles.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
  → DashedStrokeStyle
anyItem(
)
  → DashedStrokeStyle
count(
)
  → number
everyItem(
)
  → DashedStrokeStyle
firstItem(
)
  → DashedStrokeStyle
item(
index)
  → DashedStrokeStyle
itemByID(
id)
  → DashedStrokeStyle
itemByName(
name)
  → DashedStrokeStyle
itemByRange(
from, to)
  → DashedStrokeStyle
lastItem(
)
  → DashedStrokeStyle
middleItem(
)
  → DashedStrokeStyle
nextItem(
obj)
  → DashedStrokeStyle
previousItem(
obj)
  → DashedStrokeStyle
toSource(
)
  → string
add(
[withProperties])
  → DashedStrokeStyle
Creates a new DashedStrokeStyle.
withProperties Object Initial values for properties of the new DashedStrokeStyle (Optional)
anyItem(
)
  → DashedStrokeStyle
Returns any DashedStrokeStyle in the collection.
count(
)
  → number
Displays the number of elements in the DashedStrokeStyle.
everyItem(
)
  → DashedStrokeStyle
Returns every DashedStrokeStyle in the collection.
firstItem(
)
  → DashedStrokeStyle
Returns the first DashedStrokeStyle in the collection.
item(
index)
  → DashedStrokeStyle
Returns the DashedStrokeStyle with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → DashedStrokeStyle
Returns the DashedStrokeStyle with the specified ID.
id number The ID.
itemByName(
name)
  → DashedStrokeStyle
Returns the DashedStrokeStyle with the specified name.
name string The name.
itemByRange(
from, to)
  → DashedStrokeStyle
Returns the DashedStrokeStyles within the specified range.
from The DashedStrokeStyle, index, or name at the beginning of the range. Can accept: DashedStrokeStyle, Long Integer or String.
to The DashedStrokeStyle, index, or name at the end of the range. Can accept: DashedStrokeStyle, Long Integer or String.
lastItem(
)
  → DashedStrokeStyle
Returns the last DashedStrokeStyle in the collection.
middleItem(
)
  → DashedStrokeStyle
Returns the middle DashedStrokeStyle in the collection.
nextItem(
obj)
  → DashedStrokeStyle
Returns the DashedStrokeStyle whose index follows the specified DashedStrokeStyle in the collection.
obj DashedStrokeStyle The DashedStrokeStyle whose index comes before the desired DashedStrokeStyle.
previousItem(
obj)
  → DashedStrokeStyle
Returns the DashedStrokeStyle with the index previous to the specified index.
obj DashedStrokeStyle The index of the DashedStrokeStyle that follows the desired DashedStrokeStyle.
toSource(
)
  → string
Generates a string which, if executed, will return the DashedStrokeStyle.