K4 InDesign Javascript API Documentation

K4 ServerK4BeforeDialogObjects

K4 Before Dialog Objects

Instance Properties

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

Methods

anyItem(
)
  → K4BeforeDialogObject
count(
)
  → number
everyItem(
)
  → K4BeforeDialogObject
firstItem(
)
  → K4BeforeDialogObject
item(
index)
  → K4BeforeDialogObject
itemByRange(
from, to)
  → K4BeforeDialogObject
lastItem(
)
  → K4BeforeDialogObject
middleItem(
)
  → K4BeforeDialogObject
nextItem(
obj)
  → K4BeforeDialogObject
previousItem(
obj)
  → K4BeforeDialogObject
toSource(
)
  → string
anyItem(
)
  → K4BeforeDialogObject
Returns any K4BeforeDialogObject in the collection.
count(
)
  → number
Displays the number of elements in the K4BeforeDialogObject.
everyItem(
)
  → K4BeforeDialogObject
Returns every K4BeforeDialogObject in the collection.
firstItem(
)
  → K4BeforeDialogObject
Returns the first K4BeforeDialogObject in the collection.
item(
index)
  → K4BeforeDialogObject
Returns the K4BeforeDialogObject with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → K4BeforeDialogObject
Returns the K4BeforeDialogObjects within the specified range.
from The K4BeforeDialogObject, index, or name at the beginning of the range. Can accept: K4BeforeDialogObject, Long Integer or String.
to The K4BeforeDialogObject, index, or name at the end of the range. Can accept: K4BeforeDialogObject, Long Integer or String.
lastItem(
)
  → K4BeforeDialogObject
Returns the last K4BeforeDialogObject in the collection.
middleItem(
)
  → K4BeforeDialogObject
Returns the middle K4BeforeDialogObject in the collection.
nextItem(
obj)
  → K4BeforeDialogObject
Returns the K4BeforeDialogObject whose index follows the specified K4BeforeDialogObject in the collection.
obj K4BeforeDialogObject The K4BeforeDialogObject whose index comes before the desired K4BeforeDialogObject.
previousItem(
obj)
  → K4BeforeDialogObject
Returns the K4BeforeDialogObject with the index previous to the specified index.
obj K4BeforeDialogObject The index of the K4BeforeDialogObject that follows the desired K4BeforeDialogObject.
toSource(
)
  → string
Generates a string which, if executed, will return the K4BeforeDialogObject.