K4 InDesign Javascript API Documentation

K4 ServerK4ServerObjects

K4 Server Objects

Instance Properties

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

Methods

anyItem(
)
  → K4ServerObject
count(
)
  → number
everyItem(
)
  → K4ServerObject
firstItem(
)
  → K4ServerObject
item(
index)
  → K4ServerObject
itemByRange(
from, to)
  → K4ServerObject
k4GetByName(
k4Name)
  → Object
k4GetByWFObjectVariantId(
k4WFObjectVariantId)
  → Object
lastItem(
)
  → K4ServerObject
middleItem(
)
  → K4ServerObject
nextItem(
obj)
  → K4ServerObject
previousItem(
obj)
  → K4ServerObject
toSource(
)
  → string
anyItem(
)
  → K4ServerObject
Returns any K4ServerObject in the collection.
count(
)
  → number
Displays the number of elements in the K4ServerObject.
everyItem(
)
  → K4ServerObject
Returns every K4ServerObject in the collection.
firstItem(
)
  → K4ServerObject
Returns the first K4ServerObject in the collection.
item(
index)
  → K4ServerObject
Returns the K4ServerObject with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → K4ServerObject
Returns the K4ServerObjects within the specified range.
from The K4ServerObject, index, or name at the beginning of the range. Can accept: K4ServerObject, Long Integer or String.
to The K4ServerObject, index, or name at the end of the range. Can accept: K4ServerObject, Long Integer or String.
k4GetByName(
k4Name)
  → Object
K4 Get By Name
k4Name string K4 Name
k4GetByWFObjectVariantId(
k4WFObjectVariantId)
  → Object
K4 Get by workflow object variant ID
k4WFObjectVariantId string K4 Workflow object variant ID
lastItem(
)
  → K4ServerObject
Returns the last K4ServerObject in the collection.
middleItem(
)
  → K4ServerObject
Returns the middle K4ServerObject in the collection.
nextItem(
obj)
  → K4ServerObject
Returns the K4ServerObject whose index follows the specified K4ServerObject in the collection.
obj K4ServerObject The K4ServerObject whose index comes before the desired K4ServerObject.
previousItem(
obj)
  → K4ServerObject
Returns the K4ServerObject with the index previous to the specified index.
obj K4ServerObject The index of the K4ServerObject that follows the desired K4ServerObject.
toSource(
)
  → string
Generates a string which, if executed, will return the K4ServerObject.