Rectangles
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Rectangle [] (index:
number)
Returns the Rectangle with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Rectangle add ([layer:
Layer][, at:
LocationOptions=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: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location at which to insert the Rectangle relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
| reference | Document Layer MasterSpread Page PageItem Spread | 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) |
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:
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. |
Rectangle itemByID (id:
number)
Returns the Rectangle with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Rectangle itemByName (name:
string)
Returns the Rectangle with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Rectangle itemByRange (from:
any, to:
any)
Returns the Rectangles within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer Rectangle String | The Rectangle, index, or name at the beginning of the range. Can accept: Rectangle, Long Integer or String. |
| to | Long 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.
| Parameter | Type | Description |
|---|---|---|
| obj | Rectangle | 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 | 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
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |