K4 InDesign Javascript API Documentation

Interactive ElementsListBoxes

A collection of listboxes.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → ListBox
anyItem(
)
  → ListBox
count(
)
  → number
everyItem(
)
  → ListBox
firstItem(
)
  → ListBox
item(
index)
  → ListBox
itemByID(
id)
  → ListBox
itemByName(
name)
  → ListBox
itemByRange(
from, to)
  → ListBox
lastItem(
)
  → ListBox
middleItem(
)
  → ListBox
nextItem(
obj)
  → ListBox
previousItem(
obj)
  → ListBox
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → ListBox
Creates a new ListBox
layer Layer The layer on which to create the ListBox. (Optional)
at LocationOptions The location at which to insert the ListBox relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new ListBox (Optional)
anyItem(
)
  → ListBox
Returns any ListBox in the collection.
count(
)
  → number
Displays the number of elements in the ListBox.
everyItem(
)
  → ListBox
Returns every ListBox in the collection.
firstItem(
)
  → ListBox
Returns the first ListBox in the collection.
item(
index)
  → ListBox
Returns the ListBox with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → ListBox
Returns the ListBox with the specified ID.
id number The ID.
itemByName(
name)
  → ListBox
Returns the ListBox with the specified name.
name string The name.
itemByRange(
from, to)
  → ListBox
Returns the ListBoxes within the specified range.
from The ListBox, index, or name at the beginning of the range. Can accept: ListBox, Long Integer or String.
to The ListBox, index, or name at the end of the range. Can accept: ListBox, Long Integer or String.
lastItem(
)
  → ListBox
Returns the last ListBox in the collection.
middleItem(
)
  → ListBox
Returns the middle ListBox in the collection.
nextItem(
obj)
  → ListBox
Returns the ListBox whose index follows the specified ListBox in the collection.
obj ListBox The ListBox whose index comes before the desired ListBox.
previousItem(
obj)
  → ListBox
Returns the ListBox with the index previous to the specified index.
obj ListBox The index of the ListBox that follows the desired ListBox.
toSource(
)
  → string
Generates a string which, if executed, will return the ListBox.