Adobe InCopy CS5 (7.0) Object Model JS: Widgets

InCopy CS5

Class

Widgets

 A collection of widgets.

QuickLinks

[], anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Widget [] (index: number)
Returns the Widget with the specified index.

ParameterTypeDescription
indexnumberThe index.

Widget anyItem ()
Returns any Widget in the collection.

number count ()
Displays the number of elements in the Widget.

Array of Widget everyItem ()
Returns every Widget in the collection.

Widget firstItem ()
Returns the first Widget in the collection.

Widget item (index: varies)
Returns the Widget with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Widget itemByID (id: number)
Returns the Widget with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Array of Widget itemByRange (from: varies, to: varies)
Returns the Widgets within the specified range.

ParameterTypeDescription
fromLong Integer
String
Widget
The Widget, index, or name at the beginning of the range. Can accept: Widget, Long Integer or String.
toLong Integer
String
Widget
The Widget, index, or name at the end of the range. Can accept: Widget, Long Integer or String.

Widget lastItem ()
Returns the last Widget in the collection.

Widget middleItem ()
Returns the middle Widget in the collection.

Widget nextItem (obj: Widget)
Returns the Widget whose index follows the specified Widget in the collection.

ParameterTypeDescription
objWidgetThe Widget whose index comes before the desired Widget.

Widget previousItem (obj: Widget)
Returns the Widget with the index previous to the specified index.

ParameterTypeDescription
objWidgetThe index of the Widget that follows the desired Widget.

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

Element of

BorderPanel.widgets

DialogColumn.widgets

DialogRow.widgets

EnablingGroup.widgets

RadiobuttonGroup.widgets

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