K4 InDesign Javascript API Documentation

Interactive ElementsComboBoxes

A collection of comboboxes.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → ComboBox
anyItem(
)
  → ComboBox
count(
)
  → number
everyItem(
)
  → ComboBox
firstItem(
)
  → ComboBox
item(
index)
  → ComboBox
itemByID(
id)
  → ComboBox
itemByName(
name)
  → ComboBox
itemByRange(
from, to)
  → ComboBox
lastItem(
)
  → ComboBox
middleItem(
)
  → ComboBox
nextItem(
obj)
  → ComboBox
previousItem(
obj)
  → ComboBox
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → ComboBox
Creates a new ComboBox
layer Layer The layer on which to create the ComboBox. (Optional)
at LocationOptions The location at which to insert the ComboBox 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 ComboBox (Optional)
anyItem(
)
  → ComboBox
Returns any ComboBox in the collection.
count(
)
  → number
Displays the number of elements in the ComboBox.
everyItem(
)
  → ComboBox
Returns every ComboBox in the collection.
firstItem(
)
  → ComboBox
Returns the first ComboBox in the collection.
item(
index)
  → ComboBox
Returns the ComboBox with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → ComboBox
Returns the ComboBox with the specified ID.
id number The ID.
itemByName(
name)
  → ComboBox
Returns the ComboBox with the specified name.
name string The name.
itemByRange(
from, to)
  → ComboBox
Returns the ComboBoxes within the specified range.
from The ComboBox, index, or name at the beginning of the range. Can accept: ComboBox, Long Integer or String.
to The ComboBox, index, or name at the end of the range. Can accept: ComboBox, Long Integer or String.
lastItem(
)
  → ComboBox
Returns the last ComboBox in the collection.
middleItem(
)
  → ComboBox
Returns the middle ComboBox in the collection.
nextItem(
obj)
  → ComboBox
Returns the ComboBox whose index follows the specified ComboBox in the collection.
obj ComboBox The ComboBox whose index comes before the desired ComboBox.
previousItem(
obj)
  → ComboBox
Returns the ComboBox with the index previous to the specified index.
obj ComboBox The index of the ComboBox that follows the desired ComboBox.
toSource(
)
  → string
Generates a string which, if executed, will return the ComboBox.