K4 InDesign Javascript API Documentation

Interactive ElementsRadioButtons

A collection of radio buttons.

Instance Properties

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

Methods

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