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

InCopy CS5.5

Class

CheckboxControl

 A checkbox control. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
CheckboxControl
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
checkedStatebool r/wIf true, the control is checked by default in the dialog.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the CheckboxControl.
indexnumber readonlyThe index of the CheckboxControl 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 CheckboxControl (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.
staticLabelstring r/wText that appears in the CheckboxControl.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

CheckboxControl CheckboxControls.nextItem (obj: CheckboxControl)

CheckboxControl CheckboxControls.previousItem (obj: CheckboxControl)

Return

Array of CheckboxControl CheckboxControl.getElements ()

CheckboxControl CheckboxControls.[] (index: number)

CheckboxControl CheckboxControls.add ([withProperties: Object])

CheckboxControl CheckboxControls.anyItem ()

Array of CheckboxControl CheckboxControls.everyItem ()

CheckboxControl CheckboxControls.firstItem ()

CheckboxControl CheckboxControls.item (index: varies)

CheckboxControl CheckboxControls.itemByID (id: number)

Array of CheckboxControl CheckboxControls.itemByRange (from: varies, to: varies)

CheckboxControl CheckboxControls.lastItem ()

CheckboxControl CheckboxControls.middleItem ()

CheckboxControl CheckboxControls.nextItem (obj: CheckboxControl)

CheckboxControl CheckboxControls.previousItem (obj: CheckboxControl)

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