K4 InDesign Javascript API Documentation

K4 ServerK4Variants

K4 Variants

Instance Properties

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

Methods

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