Rectangles

A collection of rectangles.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Rectangle [] (index:Number)

Returns the Rectangle with the specified index.

Parameter

Type

Description

index

Number

The index.

Rectangle add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new Rectangle

Parameter

Type

Description

layer

Layer

The layer on which to create the Rectangle. (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

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

Spread

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)

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 LongInteger String)

Returns the Rectangle with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

Rectangle itemByRange (from:Varies LongInteger Rectangle String, to:Varies LongInteger Rectangle String)

Returns the Rectangles within the specified range.

Parameter

Type

Description

from

LongInteger

Rectangle

String

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

to

LongInteger

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.

Object of

PlaceGun.rectangles

Document.rectangles

Button.rectangles

State.rectangles

MultiStateObject.rectangles

CheckBox.rectangles

ComboBox.rectangles

ListBox.rectangles

RadioButton.rectangles

TextBox.rectangles

SignatureField.rectangles

Layer.rectangles

Spread.rectangles

Page.rectangles

MasterSpread.rectangles

Oval.rectangles

Rectangle.rectangles

GraphicLine.rectangles

Polygon.rectangles

Group.rectangles

SplineItem.rectangles

Snippet.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

EndnoteTextFrame.rectangles

Footnote.rectangles

XmlStory.rectangles