K4 InDesign Javascript API Documentation

K4 ServerK4Users

K4 Users

Instance Properties

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

Methods

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