Adobe InDesign CS5 (7.0) Object Model JS: RadiobuttonControl

InDesign CS5

Class

RadiobuttonControl

 An individual radiobutton control in a radiobutton group. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

RadiobuttonGroup
Widget
RadiobuttonControl
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
checkedStatebool r/wIf true, the control is checked by default in the dialog.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the RadiobuttonControl.
indexnumber readonlyThe index of the RadiobuttonControl within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
minWidthnumber r/wThe width of the control. For an editbox or combobox, specifies the minimum width of the box.
parentRadiobuttonGroup readonlyThe parent of the RadiobuttonControl (a RadiobuttonGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.
staticLabelstring r/wText that appears in the RadiobuttonControl.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of RadiobuttonControl getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the RadiobuttonControl.

string toSpecifier ()
Retrieves the object specifier.

Used in:

RadiobuttonControl RadiobuttonControls.nextItem (obj: RadiobuttonControl)

RadiobuttonControl RadiobuttonControls.previousItem (obj: RadiobuttonControl)

Return

Array of RadiobuttonControl RadiobuttonControl.getElements ()

RadiobuttonControl RadiobuttonControls.[] (index: number)

RadiobuttonControl RadiobuttonControls.add ([withProperties: Object])

RadiobuttonControl RadiobuttonControls.anyItem ()

Array of RadiobuttonControl RadiobuttonControls.everyItem ()

RadiobuttonControl RadiobuttonControls.firstItem ()

RadiobuttonControl RadiobuttonControls.item (index: varies)

RadiobuttonControl RadiobuttonControls.itemByID (id: number)

Array of RadiobuttonControl RadiobuttonControls.itemByRange (from: varies, to: varies)

RadiobuttonControl RadiobuttonControls.lastItem ()

RadiobuttonControl RadiobuttonControls.middleItem ()

RadiobuttonControl RadiobuttonControls.nextItem (obj: RadiobuttonControl)

RadiobuttonControl RadiobuttonControls.previousItem (obj: RadiobuttonControl)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index