Adobe InCopy CS5 (7.0) Object Model JS: Rectangles

InCopy CS5

Class

Rectangles

 A collection of rectangles.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

Rectangle anyItem ()
Returns any Rectangle in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objRectangleThe Rectangle whose index comes before the desired Rectangle.

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

ParameterTypeDescription
objRectangleThe index of the Rectangle that follows the desired Rectangle.

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

Element of

Button.rectangles

Cell.rectangles

Character.rectangles

Document.rectangles

Footnote.rectangles

GraphicLine.rectangles

Group.rectangles

InsertionPoint.rectangles

Layer.rectangles

Line.rectangles

MasterSpread.rectangles

MultiStateObject.rectangles

Oval.rectangles

Page.rectangles

Paragraph.rectangles

PlaceGun.rectangles

Polygon.rectangles

Rectangle.rectangles

SplineItem.rectangles

Spread.rectangles

State.rectangles

Story.rectangles

Table.rectangles

Text.rectangles

TextColumn.rectangles

TextFrame.rectangles

TextStyleRange.rectangles

Word.rectangles

XmlStory.rectangles

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