K4 InDesign Javascript API Documentation

Interactive ElementsCheckBoxes

A collection of checkboxes.

Instance Properties

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

Methods

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