Adobe InCopy CS5 (7.0) Object Model JS: Dropdown

InCopy CS5

Class

Dropdown

 A dropdown control. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

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

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the Dropdown.
indexnumber readonlyThe index of the Dropdown 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 Dropdown (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.
selectedIndexnumber r/wThe index of the selection in a dropdown or combobox control.
stringList Array of string r/wThe menu items on a dropdown or combobox control, as an array of strings.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

Dropdown Dropdowns.nextItem (obj: Dropdown)

Dropdown Dropdowns.previousItem (obj: Dropdown)

Return

Array of Dropdown Dropdown.getElements ()

Dropdown Dropdowns.[] (index: number)

Dropdown Dropdowns.add ([withProperties: Object])

Dropdown Dropdowns.anyItem ()

Array of Dropdown Dropdowns.everyItem ()

Dropdown Dropdowns.firstItem ()

Dropdown Dropdowns.item (index: varies)

Dropdown Dropdowns.itemByID (id: number)

Array of Dropdown Dropdowns.itemByRange (from: varies, to: varies)

Dropdown Dropdowns.lastItem ()

Dropdown Dropdowns.middleItem ()

Dropdown Dropdowns.nextItem (obj: Dropdown)

Dropdown Dropdowns.previousItem (obj: Dropdown)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index