Adobe InDesign CS2 (4.0) Object Model JS: Widgets

Class

Widgets

A collection of widgets.

Property	Type	Access	Description
length	number	readonly	The number of objects in the collection.

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: any)
Returns the Widget with the specified index or name.

Parameter	Type	Description
index	Long String	The index or name. Can accept: Long or String.

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

Parameter	Type	Description
id	number	The ID.

Widget itemByName (name: string)
Returns the Widget with the specified name.

Parameter	Type	Description
name	string	The name.

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

Parameter	Type	Description
from	Long String Widget	The Widget, index, or name at the beginning of the range. Can accept: Widget, Long or String.
to	Long String Widget	The Widget, index, or name at the end of the range. Can accept: Widget, Long 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.

Parameter	Type	Description
obj	Widget	The Widget whose index comes before the desired Widget.

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

Parameter	Type	Description
obj	Widget	The index of the Widget that follows the desired Widget.

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

Jongware, 27-Jun-2010 v3.0.3d