Rectangle

A rectangle.

Properties

Property	Type	Access	Description
absoluteFlip	Flip : NONE HORIZONTAL VERTICAL HORIZONTAL_AND_VERTICAL BOTH	r/w	Indicates whether the Rectangle has been flipped independently of its parent object and, if yes, the direction in which the Rectangle was flipped.
absoluteHorizontalScale	number	r/w	The horizontal scale of the Rectangle relative to its containing object.
absoluteRotationAngle	number	r/w	The rotation angle of the Rectangle relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	number	r/w	The skewing angle of the Rectangle relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	number	r/w	The vertical scale of the Rectangle relative to its containing object.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Rectangle.
allowOverrides	bool	r/w	If true, the master page Rectangle allows overrides.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Rectangle.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
appliedObjectStyle	ObjectStyle	r/w	The object style applied to the Rectangle.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Rectangle.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the Rectangle.
contentType	ContentType : UNASSIGNED GRAPHIC_TYPE TEXT_TYPE	r/w	The type of content that a frame can contain.
cornerOption	CornerOptions : NONE ROUNDED_CORNER INVERSE_ROUNDED_CORNER INSET_CORNER BEVEL_CORNER FANCY_CORNER	r/w	The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadius	number	r/w	The radius in measurement units of the corner effect.
endCap	EndCap : BUTT_END_CAP ROUND_END_CAP PROJECTING_END_CAP	r/w	The end shape of an open path.
endJoin	EndJoin : MITER_END_JOIN ROUND_END_JOIN BEVEL_END_JOIN	r/w	The corner join applied to the Rectangle.
epss	EPSs	readonly	A collection of EPS files.
fillColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the to fill the Rectangle. . Can also accept: String.
fillTint	number	r/w	The percent of tint to use in the Rectangle’s fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
fillTransparencySettings	FillTransparencySetting	readonly	Transparency settings for the fill applied to the Rectangle.
flip	Flip : NONE HORIZONTAL VERTICAL HORIZONTAL_AND_VERTICAL BOTH	r/w	The direction in which to flip the printed image.
frameFittingOptions	FrameFittingOption	readonly	The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
gapColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTint	number	r/w	The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometricBounds	Array of number	r/w	The bounds of the Rectangle excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gradientFillAngle	number	r/w	The angle of a linear gradient applied to the fill of the Rectangle. (Range: -180 to 180)
gradientFillLength	number	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Rectangle.
gradientFillStart	Array of number	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the Rectangle, in the format [x, y].
gradientStrokeAngle	number	r/w	The angle of a linear gradient applied to the stroke of the Rectangle. (Range: -180 to 180)
gradientStrokeLength	number	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Rectangle.
gradientStrokeStart	Array of number	r/w	The starting point (in page coordinates) of a gradient applied to the stroke of the Rectangle, in the format [x, y].
graphicLines	GraphicLines	readonly	A collection of graphic lines.
graphics	Graphics	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groups	Groups	readonly	A collection of groups.
horizontalScale	number	r/w	The horizontal scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
id	number	readonly	The unique ID of the Rectangle.
images	Images	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
incopyExportOptions	InCopyExportOption	readonly	Export options for InCopy INCX document format
indesignPageItems	IndesignPageItems	readonly	InDesign Page Items
index	number	readonly	The index of the Rectangle within its containing object.
itemLayer	Layer	r/w	The layer that the Rectangle is on.
label	string	r/w	A property that can be set to any string.
leftLineEnd	ArrowHead : NONE SIMPLE_ARROW_HEAD SIMPLE_WIDE_ARROW_HEAD TRIANGLE_ARROW_HEAD TRIANGLE_WIDE_ARROW_HEAD BARBED_ARROW_HEAD CURVED_ARROW_HEAD CIRCLE_ARROW_HEAD CIRCLE_SOLID_ARROW_HEAD SQUARE_ARROW_HEAD SQUARE_SOLID_ARROW_HEAD BAR_ARROW_HEAD	r/w	The arrowhead applied to the start of the path.
localDisplaySetting	DisplaySettingOptions : HIGH_QUALITY TYPICAL OPTIMIZED DEFAULT_VALUE	r/w	Display performance options for the Rectangle.
locked	bool	r/w	If true, the Rectangle is locked.
lockState	LockStateValues : NONE UNMANAGED_STORY CHECKED_IN_STORY CHECKED_OUT_STORY LOCKED_STORY EMBEDDED_STORY MISSING_LOCK_STATE MIXED_LOCK_STATE	readonly	The lock state.
miterLimit	number	r/w	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500)
movies	Movies	readonly	A collection of movies.
nonprinting	bool	r/w	If true, the Rectangle does not print.
ovals	Ovals	readonly	A collection of ellipses.
overprintFill	bool	r/w	If true, the Rectangle’s fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	bool	r/w	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	bool	r/w	If true, the Rectangle’s stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	bool	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	any	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
pageItems	PageItems	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
parent	any	readonly	The parent of the Rectangle (a Spread, MasterSpread, PageItem, Oval, Rectangle, Polygon, GraphicLine, Group, State, Document, Layer, Page, Button, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, InsertionPoint or Footnote).
paths	Paths	readonly	A collection of paths.
pdfs	PDFs	readonly	A collection of PDF files.
picts	PICTs	readonly	A collection of PICT graphics.
polygons	Polygons	readonly	A collection of polygons.
properties	Object	r/w	A property that allows setting of several properties at the same time.
rectangles	Rectangles	readonly	A collection of rectangles.
rightLineEnd	ArrowHead : NONE SIMPLE_ARROW_HEAD SIMPLE_WIDE_ARROW_HEAD TRIANGLE_ARROW_HEAD TRIANGLE_WIDE_ARROW_HEAD BARBED_ARROW_HEAD CURVED_ARROW_HEAD CIRCLE_ARROW_HEAD CIRCLE_SOLID_ARROW_HEAD SQUARE_ARROW_HEAD SQUARE_SOLID_ARROW_HEAD BAR_ARROW_HEAD	r/w	The arrowhead applied to the end of the path.
rotationAngle	number	r/w	The rotatation angle of the Rectangle. (Range: -360 to 360)
shearAngle	number	r/w	The skewing angle applied to the Rectangle. (Range: -360 to 360)
sounds	Sounds	readonly	A collection of sound clips.
storyTitle	string	r/w	Title for this InCopy story
strokeAlignment	StrokeAlignment : CENTER_ALIGNMENT INSIDE_ALIGNMENT OUTSIDE_ALIGNMENT	r/w	The stroke alignment applied to the Rectangle.
strokeColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the to stroke of the Rectangle. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment : NONE DASHES GAPS DASHES_AND_GAPS	r/w	The corner adjustment applied to the Rectangle.
strokeDashAndGap	Array of number	r/w	The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTint	number	r/w	The percent of tint to use in object’s stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeTransparencySettings	StrokeTransparencySetting	readonly	Transparency settings for the stroke.
strokeType	StrokeStyle	r/w	The name of the stroke style to apply. Can also accept: String.
strokeWeight	number	r/w	The weight (in points) to apply to the Rectangle’s stroke.
textFrames	TextFrames	readonly	A collection of text frames.
textPaths	TextPaths	readonly	A collection of text paths.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalScale	number	r/w	The vertical scaling applied to the text as a percentage of its current size. (Range: 1 to 1000)
visibleBounds	Array of number	r/w	The bounds of the Rectangle including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
wmfs	WMFs	readonly	A collection of WMF graphics.

Methods

PageItemaddPath (with:
Array of PageItem)
Creates a new page item by combining the Rectangle with other objects. Deletes the objects if they do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) to add.

void applyObjectStyle (using:
ObjectStyle[, clearingOverrides:
bool=true ][, clearingOverridesThroughRootObjectStyle:
bool=false ])
Applies the specified object style.

Parameter	Type	Description
using	ObjectStyle	The object style to apply.
clearingOverrides	bool	If true, clears the Rectangle’s existing attributes before applying the style. (Optional) (default: true )
clearingOverridesThroughRootObjectStyle	bool	If true, clears attributes and formatting applied to the Rectangle that are not defined in the object style. (Optional) (default: false )

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

void bringForward ()
Brings the Rectangle forward one level in its layer.

void bringToFront ()
Brings the Rectangle to the front of its layer.

Array of PageItemchangeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

bool checkIn ([versionComments:
string][, forceSave:
bool=false ])
Checks in the story or stories.

Parameter	Type	Description
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false )

bool checkOut ()
Checks out the story.

void clearObjectStyleOverrides ()
Clear overrides for object style

void clearTransformations ()
Clears transformations from the Rectangle. Transformations include rotation, scaling, flipping, fitting, and shearing.

void convertShape (given:
ConvertShapeOptions[, numberOfSides:
number][, insetPercentage:
number][, cornerRadius:
number])
Converts the Rectangle to a different shape.

Parameter	Type	Description
given	ConvertShapeOptions : CONVERT_TO_RECTANGLE CONVERT_TO_ROUNDED_RECTANGLE CONVERT_TO_BEVELED_RECTANGLE CONVERT_TO_INVERSE_ROUNDED_RECTANGLE CONVERT_TO_OVAL CONVERT_TO_TRIANGLE CONVERT_TO_POLYGON CONVERT_TO_LINE CONVERT_TO_STRAIGHT_LINE CONVERT_TO_OPEN_PATH CONVERT_TO_CLOSED_PATH	The Rectangle’s new shape.
numberOfSides	number	The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage	number	The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius	number	The corner radius of the resulting rectangle. (Optional)

void detach ()
Detaches an overridden master page item from the master page.

PageItemduplicate ([to:
any][, by:
Array of number])
Duplicates the Rectangle at the specified location or offset

Parameter	Type	Description
to	Array of 2 Units Spread Page Layer	The location of the new Rectangle, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of number	Amount by which to offset the new Rectangle from the original Rectangle’s position. (Optional)

PageItemexcludeOverlapPath (with:
Array of PageItem)
Creates a new page item by excluding the overlapping areas of the Rectangle and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to exclude.

void exportFile (format:
any, to:
File[, showingOptions:
bool=false ][, using:
PDFExportPreset][, versionComments:
string][, forceSave:
bool=false ])
Exports the Rectangle to file.

Parameter	Type	Description
format	ExportFormat String	The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to	File	The path to the export file.
showingOptions	bool	If true, displays the export options dialog. (Optional) (default: false )
using	PDFExportPreset	The export style. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false )

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of PageItemfindObject ([reverseOrder:
bool])
Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions : CONTENT_TO_FRAME CENTER_CONTENT PROPORTIONALLY FRAME_TO_CONTENT FILL_PROPORTIONALLY	The fit option to use.

void flipItem (given:
Flip[, around:
any])
Flips the Rectangle.

Parameter	Type	Description
given	Flip : NONE HORIZONTAL VERTICAL HORIZONTAL_AND_VERTICAL BOTH	The axis around which to flip the Rectangle.
around	Array of 2 Units AnchorPoint	The point around which to flip the Rectangle. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of RectanglegetElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

PageItemintersectPath (with:
Array of PageItem)
Creates a new page item by intersecting the Rectangle with other objects. Returns an error if the objects do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) with which to intersect.

PageItemmakeCompoundPath (with:
Array of PageItem)
Creates a compound path by combining the path of the Rectangle with the paths of other objects.

Parameter	Type	Description
with	Array of PageItem	The other objects whose paths to include in the new compound path.

void markup (using:
XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

PageItemminusBack (with:
Array of PageItem)
Creates a new page item by reverse subtracting the overlapping areas of the Rectangle and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to reverse subtract.

void move ([to:
any][, by:
Array of number])
Moves the Rectangle to a new location. Note: Either the ‘to’ or ‘by’ parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of 2 Units Spread Page Layer	The new location of the Rectangle,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of number	The amount (in measurement units) to move the Rectangle relative to its current position, in the format (x, y). (Optional)

any override (destinationPage:
Page)
Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

Array of any place (fileName:
File[, showingOptions:
bool=false ][, withProperties:
Object])
Places the file.

Parameter	Type	Description
fileName	File	The file to place
showingOptions	bool	Whether to display the import options dialog (Optional) (default: false )
withProperties	Object	Initial values for properties of the new Rectangle (Optional)

void placeXML (using:
XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

void redefineScaling ([to:
Array of number])
Move an item’s scaling to its content if possible

Parameter	Type	Description
to	Array of number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

Array of PageItemreleaseCompoundPath ()
Releases a compound path.

void remove ()
Deletes the Rectangle.

void removeOverride ()
Removes the override from a previously overridden master page item.

any resolve (location:
any, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false ])
Get the coordinates of the given location in the specified coordinate system

Parameter	Type	Description
location	Array of 2 Reals AnchorPoint Array of Arrays of 2 Reals CoordinateSpaces AnchorPoint BoundingBoxLimits	The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in	CoordinateSpaces : PASTEBOARD_COORDINATES PARENT_COORDINATES INNER_COORDINATES	The coordinate space to use
consideringRulerUnits	bool	If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

bool revert ()
Reverts the document to its state at the last save operation.

void select ([existingSelection:
SelectionOptions=REPLACE_WITH ])
Selects the Rectangle.

Parameter	Type	Description
existingSelection	SelectionOptions : ADD_TO REMOVE_FROM REPLACE_WITH	The selection status of the Rectangle in relation to previously selected objects. (Optional) (default: REPLACE_WITH )

void sendBackward ()
Sends the Rectangle back one level in its layer.

void sendToBack ()
Sends the Rectangle to the back of its layer.

Assetstore (using:
Library[, withProperties:
Object])
Stores the Rectangle(s) in the specified library.

Parameter	Type	Description
using	Library	The library in which to store the Rectangle(s).
withProperties	Object	Initial values for properties of the new Rectangle (Optional)

PageItemsubtractPath (with:
Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the Rectangle and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to subtract.

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

string toSpecifier ()
Retrieves the object specifier.

void transform (in:
CoordinateSpaces, from:
any, withMatrix:
any[, replacingCurrent:
any][, consideringRulerUnits:
bool=false ])
Transform the page item

Parameter	Type	Description
in	CoordinateSpaces : PASTEBOARD_COORDINATES PARENT_COORDINATES INNER_COORDINATES	The coordinate space to use
from	Array of 2 Reals AnchorPoint Array of Arrays of 2 Reals CoordinateSpaces AnchorPoint BoundingBoxLimits	The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	MatrixContent Array of MatrixContent Long Integer	Transform components to consider; providing this optional parameter causes the target’s existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target’s existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits	bool	If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false )

Array of string transformAgain ()
Transforms the Rectangle using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the Rectangle using the last transformation performed on any Rectangle. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgain ()
Transforms the Rectangle using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgainIndividually ()
Transforms the Rectangle using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of TransformationMatrixtransformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item

Parameter	Type	Description
in	CoordinateSpaces : PASTEBOARD_COORDINATES PARENT_COORDINATES INNER_COORDINATES	The coordinate space to use

Used in:

Rectangles.previousItem (

obj:
Rectangle )

Rectangles.nextItem (

obj:
Rectangle )

Returned by:

Array of Rectangle Rectangle .getElements (

)

Rectangle Rectangles.add (
[layer:
Layer][, at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object]
)

Rectangle Rectangles.anyItem (

)

Array of Rectangle Rectangles.everyItem (

)

Rectangle Rectangles.firstItem (

)

Rectangle Rectangles.item (
index:
any
)

Rectangle Rectangles.itemByID (
id:
number
)

Rectangle Rectangles.itemByName (
name:
string
)

Array of Rectangle Rectangles.itemByRange (
from:
any, to:
any
)

Rectangle Rectangles.lastItem (

)

Rectangle Rectangles.middleItem (

)

Rectangle Rectangles.nextItem (
obj:
Rectangle
)

Rectangle Rectangles.previousItem (
obj:
Rectangle
)