Adobe InCopy CS6 (8.0) Object Model JS: BorderPanels

InCopy CS6

Class

BorderPanels

 A collection of border panels.

See also BorderPanel.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

BorderPanel add ([withProperties: Object])
Creates a new BorderPanel.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new BorderPanel (Optional)

BorderPanel anyItem ()
Returns any BorderPanel in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
fromBorderPanel
Long Integer
String
The BorderPanel, index, or name at the beginning of the range. Can accept: BorderPanel, Long Integer or String.
toBorderPanel
Long Integer
String
The BorderPanel, index, or name at the end of the range. Can accept: BorderPanel, Long Integer or String.

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

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

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

ParameterTypeDescription
objBorderPanelThe BorderPanel whose index comes before the desired BorderPanel.

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

ParameterTypeDescription
objBorderPanelThe index of the BorderPanel that follows the desired BorderPanel.

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

Element of

BorderPanel.borderPanels

DialogColumn.borderPanels

DialogRow.borderPanels

EnablingGroup.borderPanels

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