Adobe InCopy CS5 (7.0) Object Model JS: Panels

InCopy CS5

Class

Panels

 A collection of panels.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

Panel anyItem ()
Returns any Panel in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objPanelThe Panel whose index comes before the desired Panel.

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

ParameterTypeDescription
objPanelThe index of the Panel that follows the desired Panel.

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

Element of

Application.panels

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