K4 InDesign Javascript API Documentation

Stroke StylesDottedStrokeStyles

A collection of dotted stroke styles.

Instance Properties

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

Methods

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