A collection of rectangles.
Methods
Rectangleadd ([layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new Rectangle
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the Rectangle. (Optional) |
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the Rectangle relative to the reference object or within the container object. (Optional) (default: UNKNOWN ) |
| reference | Document Spread MasterSpread Page Layer PageItem |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
| withProperties | Object | Initial values for properties of the new Rectangle (Optional) |
RectangleanyItem ()
Returns any Rectangle in the collection.
number count ()
Displays the number of elements in the Rectangle.
Array of RectangleeveryItem ()
Returns every Rectangle in the collection.
RectanglefirstItem ()
Returns the first Rectangle in the collection.
Rectangleitem (index:
any)
Returns the Rectangle with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
RectangleitemByID (id:
number)
Returns the Rectangle with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
RectangleitemByName (name:
string)
Returns the Rectangle with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of RectangleitemByRange (from:
any, to:
any)
Returns the Rectangles within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Rectangle Long Integer String |
The Rectangle, index, or name at the beginning of the range. Can accept: Rectangle, Long Integer or String. |
| to | Rectangle Long Integer String |
The Rectangle, index, or name at the end of the range. Can accept: Rectangle, Long Integer or String. |
RectanglelastItem ()
Returns the last Rectangle in the collection.
RectanglemiddleItem ()
Returns the middle Rectangle in the collection.
RectanglenextItem (obj:
Rectangle)
Returns the Rectangle whose index follows the specified Rectangle in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Rectangle | The Rectangle whose index comes before the desired Rectangle. |
RectanglepreviousItem (obj:
Rectangle)
Returns the Rectangle with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Rectangle | The 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
Oval.rectangles
Page.rectangles
PageItem.rectangles
Paragraph.rectangles
Polygon.rectangles
Rectangle.rectangles
Spread.rectangles
State.rectangles
Story.rectangles
Table.rectangles
Text.rectangles
TextColumn.rectangles
TextFrame.rectangles
TextStyleRange.rectangles
Word.rectangles