Adobe InCopy CS5.5 (7.5) Object Model JS: RadiobuttonGroup

InCopy CS5.5

Class

RadiobuttonGroup

 A single control that contains one or more radiobutton controls. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
RadiobuttonGroup
Event | EventListener | MutationEvent | RadiobuttonControl | Widget

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the RadiobuttonGroup.
indexnumber readonlyThe index of the RadiobuttonGroup 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.
parentBorderPanelDialogColumn
DialogRow
EnablingGroup
readonlyThe parent of the RadiobuttonGroup (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.
radiobuttonControlsRadiobuttonControls RadiobuttonControl readonlyA collection of individual radiobutton controls.
selectedButtonnumber r/wThe index of the selection in a radiobutton group.
widgetsWidgets Widget readonlyA collection of widgets.

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 RadiobuttonGroup 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 RadiobuttonGroup.

string toSpecifier ()
Retrieves the object specifier.

Element of

RadiobuttonControl.parent

Widget.parent

Used in:

RadiobuttonGroup RadiobuttonGroups.nextItem (obj: RadiobuttonGroup)

RadiobuttonGroup RadiobuttonGroups.previousItem (obj: RadiobuttonGroup)

Return

Array of RadiobuttonGroup RadiobuttonGroup.getElements ()

RadiobuttonGroup RadiobuttonGroups.[] (index: number)

RadiobuttonGroup RadiobuttonGroups.add ([withProperties: Object])

RadiobuttonGroup RadiobuttonGroups.anyItem ()

Array of RadiobuttonGroup RadiobuttonGroups.everyItem ()

RadiobuttonGroup RadiobuttonGroups.firstItem ()

RadiobuttonGroup RadiobuttonGroups.item (index: varies)

RadiobuttonGroup RadiobuttonGroups.itemByID (id: number)

Array of RadiobuttonGroup RadiobuttonGroups.itemByRange (from: varies, to: varies)

RadiobuttonGroup RadiobuttonGroups.lastItem ()

RadiobuttonGroup RadiobuttonGroups.middleItem ()

RadiobuttonGroup RadiobuttonGroups.nextItem (obj: RadiobuttonGroup)

RadiobuttonGroup RadiobuttonGroups.previousItem (obj: RadiobuttonGroup)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index