K4 InDesign Javascript API Documentation

K4 ServerK4Queries

K4 Queries

Instance Properties

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

Methods

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