A collection of rectangles.
Go to Property Listing | Method Listing
add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Rectangle add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)
Create a new Rectangle
|
Parameter |
Type |
Description |
|---|---|---|
|
layer |
The layer on which to create the Rectangle. (Optional) |
|
|
at |
Location (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
Before/after this Rectangle or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional) |
|
|
withProperties |
Initial values for properties of the new Rectangle (Optional) |
Rectangle anyItem ()
Returns any Rectangle in the collection.
Number count ()
Displays the number of elements in the Rectangle.
Rectangle everyItem ()
Returns every Rectangle in the collection.
Rectangle firstItem ()
Returns the first Rectangle in the collection.
Rectangle item (index:Varies Long String)
Returns the Rectangle with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Long |
The index or name. Can accept: Long or String. |
Rectangle itemByID (id:Number)
Returns the Rectangle with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Rectangle itemByName (name:String)
Returns the Rectangle with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Rectangle itemByRange (from:Varies Long Rectangle String, to:Varies Long Rectangle String)
Returns the Rectangles within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Long |
The Rectangle, index, or name at the beginning of the range. Can accept: Rectangle, Long or String. |
|
to |
Long |
The Rectangle, index, or name at the end of the range. Can accept: Rectangle, Long 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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Rectangle whose index comes before the desired Rectangle. |
Rectangle previousItem (obj:Rectangle)
Returns the Rectangle with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Rectangle that follows the desired Rectangle. |
String toSource ()
Generates a string which, if executed, will return the Rectangle.
Document.rectangles
Button.rectangles
State.rectangles
Layer.rectangles
Spread.rectangles
Page.rectangles
MasterSpread.rectangles
PageItem.rectangles
Oval.rectangles
Rectangle.rectangles
GraphicLine.rectangles
Polygon.rectangles
Group.rectangles
Cell.rectangles
Table.rectangles
Text.rectangles
Character.rectangles
Word.rectangles
Line.rectangles
TextColumn.rectangles
Paragraph.rectangles
TextStyleRange.rectangles
InsertionPoint.rectangles
TextFrame.rectangles
Story.rectangles
Footnote.rectangles