K4 InDesign Javascript API Documentation

Stroke StylesStripedStrokeStyles

A collection of striped stroke styles.

Instance Properties

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

Methods

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