K4 InDesign Javascript API Documentation

K4 ServerK4Groups

K4 User Groups

Instance Properties

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

Methods

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