Packagecom.adobe.indesign
Classpublic class Rectangle
InheritanceRectangle Inheritance SplineItem Inheritance PageItem Inheritance CSHostObject Inheritance flash.utils.Proxy

SplineItem



Public Properties
 PropertyDefined By
  absoluteFlip : Flip
[override] Indicates whether the Rectangle has been flipped independently of its parent object and, if yes, the direction in which the Rectangle was flipped.
Rectangle
  absoluteHorizontalScale : Number
[override] The horizontal scale of the Rectangle relative to its containing object.
Rectangle
  absoluteRotationAngle : Number
[override] The rotation angle of the Rectangle relative to its containing object.
Rectangle
  absoluteShearAngle : Number
[override] The skewing angle of the Rectangle relative to its containing object.
Rectangle
  absoluteVerticalScale : Number
[override] The vertical scale of the Rectangle relative to its containing object.
Rectangle
  AFTER_PLACE : String
[static] [read-only] Dispatched after a Rectangle is placed.
Rectangle
  allGraphics : Object
[override] [read-only] Lists all graphics contained by the Rectangle.
Rectangle
  allowOverrides : Boolean
[override] If true, the master page item can be overridden.
Rectangle
  allPageItems : Object
[override] [read-only] Lists all page items contained by the Rectangle.
Rectangle
  anchoredObjectSettings : AnchoredObjectSetting
[override] [read-only] Anchored object settings.
Rectangle
  animationSettings : AnimationSetting
[override] [read-only] The page item animation settings.
Rectangle
  appliedObjectStyle : ObjectStyle
[override] The object style applied to the Rectangle.
Rectangle
  associatedXMLElement : XMLItem
[override] [read-only] The XML element associated with the Rectangle.
Rectangle
  BEFORE_PLACE : String
[static] [read-only] Dispatched before a Rectangle is placed.
Rectangle
  bottomLeftCornerOption : CornerOptions
[override] The shape to apply to the bottom left corner of rectangular shapes.
Rectangle
  bottomLeftCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
Rectangle
  bottomRightCornerOption : CornerOptions
[override] The shape to apply to the bottom right corner of rectangular shapes.
Rectangle
  bottomRightCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
Rectangle
  buttons : Buttons
[override] [read-only] A collection of buttons.
Rectangle
  contentTransparencySettings : ContentTransparencySetting
[override] [read-only] Transparency settings for the content of the Rectangle.
Rectangle
  contentType : ContentType
[override] The type of content that a frame can contain.
Rectangle
  endCap : EndCap
[override] The end shape of an open path.
Rectangle
  endJoin : EndJoin
[override] The corner join applied to the Rectangle.
Rectangle
  epss : EPSs
[override] [read-only] A collection of EPS files.
Rectangle
  epstexts : EPSTexts
[override] [read-only] EPSTexts
Rectangle
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
Rectangle
  events : Events
[override] [read-only] A collection of events.
Rectangle
  fillColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Rectangle.
Rectangle
  fillTint : Number
[override] The percent of tint to use in the Rectangle's fill color.
Rectangle
  fillTransparencySettings : FillTransparencySetting
[override] [read-only] Transparency settings for the fill applied to the Rectangle.
Rectangle
  flip : Flip
[override] The direction in which to flip the printed image.
Rectangle
  formFields : FormFields
[override] [read-only] A collection of form fields.
Rectangle
  frameFittingOptions : FrameFittingOption
[read-only] The frame fitting option to apply to placed or pasted content.
Rectangle
  gapColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke.
Rectangle
  gapTint : Number
[override] The tint as a percentage of the gap color.
Rectangle
  geometricBounds : Object
[override] 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.
Rectangle
  gradientFillAngle : Number
[override] The angle of a linear gradient applied to the fill of the Rectangle.
Rectangle
  gradientFillLength : Object
[override] The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Rectangle.
Rectangle
  gradientFillStart : Object
[override] The starting point (in page coordinates) of a gradient applied to the fill of the Rectangle, in the format [x, y].
Rectangle
  gradientStrokeAngle : Number
[override] The angle of a linear gradient applied to the stroke of the Rectangle.
Rectangle
  gradientStrokeLength : Object
[override] The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Rectangle.
Rectangle
  gradientStrokeStart : Object
[override] The starting point (in page coordinates) of a gradient applied to the stroke of the Rectangle, in the format [x, y].
Rectangle
  graphicLines : GraphicLines
[override] [read-only] A collection of graphic lines.
Rectangle
  graphics : Graphics
[override] [read-only] A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Rectangle
  groups : Groups
[override] [read-only] A collection of groups.
Rectangle
  horizontalScale : Number
[override] The horizontal scaling applied to the Rectangle.
Rectangle
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[override] [read-only] The unique ID of the Rectangle.
Rectangle
  images : Images
[override] [read-only] A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
Rectangle
  importedPages : ImportedPages
[override] [read-only] Imported InDesign pages.
Rectangle
  incopyExportOptions : InCopyExportOption
[read-only] Export options for InCopy INCX document format.
Rectangle
  index : Number
[override] [read-only] The index of the Rectangle within its containing object.
Rectangle
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
Rectangle
  itemLayer : Layer
[override] The layer that the Rectangle is on.
Rectangle
  label : String
[override] A property that can be set to any string.
Rectangle
  leftLineEnd : ArrowHead
[override] The arrowhead applied to the start of the path.
Rectangle
  localDisplaySetting : DisplaySettingOptions
[override] Display performance options for the Rectangle.
Rectangle
  locked : Boolean
[override] If true, the Rectangle is locked.
Rectangle
  lockState : LockStateValues
[override] [read-only] The lock state.
Rectangle
  mediaItems : MediaItems
[override] [read-only] The media items collection.
Rectangle
  miterLimit : Number
[override] The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
Rectangle
  movies : Movies
[override] [read-only] A collection of movies.
Rectangle
  multiStateObjects : MultiStateObjects
[override] [read-only] A collection of multi-state objects.
Rectangle
  name : String
[override] The name of the Rectangle.
Rectangle
  nonprinting : Boolean
[override] If true, the Rectangle does not print.
Rectangle
  ovals : Ovals
[override] [read-only] A collection of ellipses.
Rectangle
  overprintFill : Boolean
[override] If true, the Rectangle's fill color overprints any underlying objects.
Rectangle
  overprintGap : Boolean
[override] If true, the gap color overprints any underlying colors.
Rectangle
  overprintStroke : Boolean
[override] If true, the Rectangle's stroke color overprints any underlying objects.
Rectangle
  overridden : Boolean
[override] [read-only] If true, the object originated on a master spread and was overridden.
Rectangle
  overriddenMasterPageItem : Object
[override] [read-only] An object that originated on a master page and has been overridden.
Rectangle
  pageItems : PageItems
[override] [read-only] 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.
Rectangle
  parent : Object
[override] [read-only] The parent of the Rectangle (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).
Rectangle
  parentPage : Page
[override] [read-only] The page on which this page item appears.
Rectangle
  paths : Paths
[override] [read-only] A collection of paths.
Rectangle
  pdfs : PDFs
[override] [read-only] A collection of PDF files.
Rectangle
  picts : PICTs
[override] [read-only] A collection of PICT graphics.
Rectangle
  polygons : Polygons
[override] [read-only] A collection of polygons.
Rectangle
  preferences : Preferences
[override] [read-only] A collection of preferences objects.
Rectangle
  properties : Object
[override] A property that allows setting of several properties at the same time.
Rectangle
  rectangles : Rectangles
[override] [read-only] A collection of rectangles.
Rectangle
  rightLineEnd : ArrowHead
[override] The arrowhead applied to the end of the path.
Rectangle
  rotationAngle : Number
[override] The rotatation angle of the Rectangle.
Rectangle
  shearAngle : Number
[override] The skewing angle applied to the Rectangle.
Rectangle
  sounds : Sounds
[override] [read-only] A collection of sound clips.
Rectangle
  splineItems : SplineItems
[override] [read-only] The spline items collection.
Rectangle
  storyTitle : String
Title for this InCopy story.
Rectangle
  strokeAlignment : StrokeAlignment
[override] The stroke alignment applied to the Rectangle.
Rectangle
  strokeColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Rectangle.
Rectangle
  strokeCornerAdjustment : StrokeCornerAdjustment
[override] The corner adjustment applied to the Rectangle.
Rectangle
  strokeDashAndGap : Object
[override] The dash and gap measurements that define the pattern of a custom dashed line.
Rectangle
  strokeTint : Number
[override] The percent of tint to use in object's stroke color.
Rectangle
  strokeTransparencySettings : StrokeTransparencySetting
[override] [read-only] Transparency settings for the stroke.
Rectangle
  strokeType : StrokeStyle
[override] The name of the stroke style to apply.
Rectangle
  strokeWeight : Object
[override] The weight (in points) to apply to the Rectangle's stroke.
Rectangle
  textFrames : TextFrames
[override] [read-only] A collection of text frames.
Rectangle
  textPaths : TextPaths
[override] [read-only] A collection of text paths.
Rectangle
  textWrapPreferences : TextWrapPreference
[override] [read-only] The text wrap preference properties that define the default formatting for wrapping text around objects.
Rectangle
  timingSettings : TimingSetting
[override] [read-only] The object timing settings.
Rectangle
  topLeftCornerOption : CornerOptions
[override] The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
Rectangle
  topLeftCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
Rectangle
  topRightCornerOption : CornerOptions
[override] The shape to apply to the top right corner of rectangular shapes
Rectangle
  topRightCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
Rectangle
  transparencySettings : TransparencySetting
[override] [read-only] Transparency settings.
Rectangle
  verticalScale : Number
[override] The vertical scaling applied to the Rectangle.
Rectangle
  visible : Boolean
[override] If true, the Rectangle is visible.
Rectangle
  visibleBounds : Object
[override] 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.
Rectangle
  wmfs : WMFs
[override] [read-only] A collection of WMF graphics.
Rectangle
Public Methods
 MethodDefined By
 Inherited
addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PageItem
  
addEventListenerRectangle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Rectangle
 Inherited
addEventListenerSplineItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
SplineItem
  
addPath(withParam:Array = null):PageItem
[override] Creates a new page item by combining the Rectangle with other objects.
Rectangle
  
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
[override] Applies the specified object style.
Rectangle
  
asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask
[override] asynchronously exports the object(s) to a file.
Rectangle
  
autoTag():void
[override] Tag the object or the parent story using default tags defined in XML preference.
Rectangle
  
[override] Brings the Rectangle forward one level in its layer.
Rectangle
  
bringToFront(referenceParam:PageItem = null):void
[override] Brings the Rectangle to the front of its layer or in front of a particular item.
Rectangle
  
changeObject(reverseOrderParam:Boolean):Object
[override] Finds objects that match the find what value and replace the objects with the change to value.
Rectangle
  
checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
[override] Checks in the story or stories.
Rectangle
  
checkOut():Boolean
[override] Checks out the story.
Rectangle
  
Removes the frame fittings options and resets it to the initial state.
Rectangle
  
[override] Clear overrides for object style
Rectangle
  
[override] Clears transformations from the Rectangle.
Rectangle
  
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
[override] Converts the Rectangle to a different shape.
Rectangle
  
detach():void
[override] Detaches an overridden master page item from the master page.
Rectangle
  
duplicate(toParam:Object = null, byParam:Array = null):PageItem
[override] Duplicates the Rectangle at the specified location or offset.
Rectangle
  
excludeOverlapPath(withParam:Array = null):PageItem
[override] Creates a new page item by excluding the overlapping areas of the Rectangle and other objects.
Rectangle
  
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
[override] Exports the object(s) to a file.
Rectangle
  
extractLabel(keyParam:String = null):String
[override] Gets the label value associated with the specified key.
Rectangle
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
findObject(reverseOrderParam:Boolean):Object
[override] Finds objects that match the find what value.
Rectangle
  
fit(givenParam:FitOptions = null):void
[override] Applies the specified fit option to content in a frame.
Rectangle
  
flipItem(givenParam:Flip = null, aroundParam:Object = null):void
[override] Flips the Rectangle.
Rectangle
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
Rectangle
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
[override] Sets the label to the value associated with the specified key.
Rectangle
  
intersectPath(withParam:Array = null):PageItem
[override] Creates a new page item by intersecting the Rectangle with other objects.
Rectangle
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
makeCompoundPath(withParam:Array = null):PageItem
[override] Creates a compound path by combining the path(s) of the Rectangle with the paths of other objects.
Rectangle
  
markup(usingParam:XMLElement = null):void
[override] Associates the page item with the specified XML element while preserving existing content.
Rectangle
  
minusBack(withParam:Array = null):PageItem
[override] Creates a new page item by reverse subtracting the overlapping areas of the Rectangle and other objects.
Rectangle
  
move(toParam:Object = null, byParam:Array = null):void
[override] Moves the Rectangle to a new location.
Rectangle
  
override(destinationPageParam:Page = null):Object
[override] Overrides a master page item and places the item on the document page as a new object.
Rectangle
  
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
[override] Places the file.
Rectangle
  
placeXML(usingParam:XMLElement = null):void
[override] Places XML content into the specified object.
Rectangle
  
redefineScaling(toParam:Array = null):void
[override] Apply an item's scaling to its content if possible.
Rectangle
  
reframe(inParam:Object = null, opposingCornersParam:Array = null):void
[override] Move the bounding box of the page item
Rectangle
  
[override] Releases a compound path.
Rectangle
  
remove():void
[override] Deletes the Rectangle.
Rectangle
 Inherited
removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PageItem
  
removeEventListenerRectangle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Rectangle
 Inherited
removeEventListenerSplineItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
SplineItem
  
[override] Removes the override from a previously overridden master page item.
Rectangle
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void
[override] Resize the page item.
Rectangle
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
[override] Get the coordinates of the given location in the specified coordinate system.
Rectangle
  
revert():Boolean
[override] Reverts the document to its state at the last save operation.
Rectangle
  
select(existingSelectionParam:SelectionOptions = null):void
[override] Selects the object.
Rectangle
  
[override] Sends the Rectangle back one level in its layer.
Rectangle
  
sendToBack(referenceParam:PageItem = null):void
[override] Sends the Rectangle to the back of its layer or behind a particular item (must have same parent).
Rectangle
  
store(usingParam:Library = null, withPropertiesParam:Object = null):Asset
[override] Stores the object in the specified library.
Rectangle
  
subtractPath(withParam:Array = null):PageItem
[override] Creates a new page item by subtracting the overlapping areas of the Rectangle and other objects.
Rectangle
  
toSpecifier():String
[override] Retrieves the object specifier.
Rectangle
  
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
[override] Transform the page item.
Rectangle
  
[override] Transforms the Rectangle using the last transformation performed on any object.
Rectangle
  
[override] Transforms the Rectangle using the last transformation performed on any Rectangle.
Rectangle
  
[override] 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.
Rectangle
  
[override] 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.
Rectangle
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
[override] Get the transformation values of the page item.
Rectangle
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
absoluteFlipproperty
absoluteFlip:Flip[override]

Indicates whether the Rectangle has been flipped independently of its parent object and, if yes, the direction in which the Rectangle was flipped.


Implementation
    public function get absoluteFlip():Flip
    public function set absoluteFlip(value:Flip):void
absoluteHorizontalScaleproperty 
absoluteHorizontalScale:Number[override]

The horizontal scale of the Rectangle relative to its containing object.


Implementation
    public function get absoluteHorizontalScale():Number
    public function set absoluteHorizontalScale(value:Number):void
absoluteRotationAngleproperty 
absoluteRotationAngle:Number[override]

The rotation angle of the Rectangle relative to its containing object. (Range: -360 to 360)


Implementation
    public function get absoluteRotationAngle():Number
    public function set absoluteRotationAngle(value:Number):void
absoluteShearAngleproperty 
absoluteShearAngle:Number[override]

The skewing angle of the Rectangle relative to its containing object. (Range: -360 to 360)


Implementation
    public function get absoluteShearAngle():Number
    public function set absoluteShearAngle(value:Number):void
absoluteVerticalScaleproperty 
absoluteVerticalScale:Number[override]

The vertical scale of the Rectangle relative to its containing object.


Implementation
    public function get absoluteVerticalScale():Number
    public function set absoluteVerticalScale(value:Number):void
AFTER_PLACEproperty 
AFTER_PLACE:String  [read-only]

Dispatched after a Rectangle is placed. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_PLACE():String
allGraphicsproperty 
allGraphics:Object  [read-only] [override]

Lists all graphics contained by the Rectangle.


Implementation
    public function get allGraphics():Object
allowOverridesproperty 
allowOverrides:Boolean[override]

If true, the master page item can be overridden.


Implementation
    public function get allowOverrides():Boolean
    public function set allowOverrides(value:Boolean):void
allPageItemsproperty 
allPageItems:Object  [read-only] [override]

Lists all page items contained by the Rectangle.


Implementation
    public function get allPageItems():Object
anchoredObjectSettingsproperty 
anchoredObjectSettings:AnchoredObjectSetting  [read-only] [override]

Anchored object settings.


Implementation
    public function get anchoredObjectSettings():AnchoredObjectSetting
animationSettingsproperty 
animationSettings:AnimationSetting  [read-only] [override]

The page item animation settings.


Implementation
    public function get animationSettings():AnimationSetting
appliedObjectStyleproperty 
appliedObjectStyle:ObjectStyle[override]

The object style applied to the Rectangle.


Implementation
    public function get appliedObjectStyle():ObjectStyle
    public function set appliedObjectStyle(value:ObjectStyle):void
associatedXMLElementproperty 
associatedXMLElement:XMLItem  [read-only] [override]

The XML element associated with the Rectangle.


Implementation
    public function get associatedXMLElement():XMLItem
BEFORE_PLACEproperty 
BEFORE_PLACE:String  [read-only]

Dispatched before a Rectangle is placed. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_PLACE():String
bottomLeftCornerOptionproperty 
bottomLeftCornerOption:CornerOptions[override]

The shape to apply to the bottom left corner of rectangular shapes.


Implementation
    public function get bottomLeftCornerOption():CornerOptions
    public function set bottomLeftCornerOption(value:CornerOptions):void
bottomLeftCornerRadiusproperty 
bottomLeftCornerRadius:Object[override]

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes


Implementation
    public function get bottomLeftCornerRadius():Object
    public function set bottomLeftCornerRadius(value:Object):void
bottomRightCornerOptionproperty 
bottomRightCornerOption:CornerOptions[override]

The shape to apply to the bottom right corner of rectangular shapes.


Implementation
    public function get bottomRightCornerOption():CornerOptions
    public function set bottomRightCornerOption(value:CornerOptions):void
bottomRightCornerRadiusproperty 
bottomRightCornerRadius:Object[override]

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes


Implementation
    public function get bottomRightCornerRadius():Object
    public function set bottomRightCornerRadius(value:Object):void
buttonsproperty 
buttons:Buttons  [read-only] [override]

A collection of buttons.


Implementation
    public function get buttons():Buttons
contentTransparencySettingsproperty 
contentTransparencySettings:ContentTransparencySetting  [read-only] [override]

Transparency settings for the content of the Rectangle.


Implementation
    public function get contentTransparencySettings():ContentTransparencySetting
contentTypeproperty 
contentType:ContentType[override]

The type of content that a frame can contain.


Implementation
    public function get contentType():ContentType
    public function set contentType(value:ContentType):void
endCapproperty 
endCap:EndCap[override]

The end shape of an open path.


Implementation
    public function get endCap():EndCap
    public function set endCap(value:EndCap):void
endJoinproperty 
endJoin:EndJoin[override]

The corner join applied to the Rectangle.


Implementation
    public function get endJoin():EndJoin
    public function set endJoin(value:EndJoin):void
epssproperty 
epss:EPSs  [read-only] [override]

A collection of EPS files.


Implementation
    public function get epss():EPSs
epstextsproperty 
epstexts:EPSTexts  [read-only] [override]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
fillColorproperty 
fillColor:Swatch[override]

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Rectangle. . Can also accept: String.


Implementation
    public function get fillColor():Swatch
    public function set fillColor(value:Swatch):void
fillTintproperty 
fillTint:Number[override]

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


Implementation
    public function get fillTint():Number
    public function set fillTint(value:Number):void
fillTransparencySettingsproperty 
fillTransparencySettings:FillTransparencySetting  [read-only] [override]

Transparency settings for the fill applied to the Rectangle.


Implementation
    public function get fillTransparencySettings():FillTransparencySetting
flipproperty 
flip:Flip[override]

The direction in which to flip the printed image.


Implementation
    public function get flip():Flip
    public function set flip(value:Flip):void
formFieldsproperty 
formFields:FormFields  [read-only] [override]

A collection of form fields.


Implementation
    public function get formFields():FormFields
frameFittingOptionsproperty 
frameFittingOptions:FrameFittingOption  [read-only]

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.


Implementation
    public function get frameFittingOptions():FrameFittingOption
gapColorproperty 
gapColor:Swatch[override]

The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.


Implementation
    public function get gapColor():Swatch
    public function set gapColor(value:Swatch):void
gapTintproperty 
gapTint:Number[override]

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


Implementation
    public function get gapTint():Number
    public function set gapTint(value:Number):void
geometricBoundsproperty 
geometricBounds:Object[override]

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.


Implementation
    public function get geometricBounds():Object
    public function set geometricBounds(value:Object):void
gradientFillAngleproperty 
gradientFillAngle:Number[override]

The angle of a linear gradient applied to the fill of the Rectangle. (Range: -180 to 180)


Implementation
    public function get gradientFillAngle():Number
    public function set gradientFillAngle(value:Number):void
gradientFillLengthproperty 
gradientFillLength:Object[override]

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Rectangle.


Implementation
    public function get gradientFillLength():Object
    public function set gradientFillLength(value:Object):void
gradientFillStartproperty 
gradientFillStart:Object[override]

The starting point (in page coordinates) of a gradient applied to the fill of the Rectangle, in the format [x, y].


Implementation
    public function get gradientFillStart():Object
    public function set gradientFillStart(value:Object):void
gradientStrokeAngleproperty 
gradientStrokeAngle:Number[override]

The angle of a linear gradient applied to the stroke of the Rectangle. (Range: -180 to 180)


Implementation
    public function get gradientStrokeAngle():Number
    public function set gradientStrokeAngle(value:Number):void
gradientStrokeLengthproperty 
gradientStrokeLength:Object[override]

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Rectangle.


Implementation
    public function get gradientStrokeLength():Object
    public function set gradientStrokeLength(value:Object):void
gradientStrokeStartproperty 
gradientStrokeStart:Object[override]

The starting point (in page coordinates) of a gradient applied to the stroke of the Rectangle, in the format [x, y].


Implementation
    public function get gradientStrokeStart():Object
    public function set gradientStrokeStart(value:Object):void
graphicLinesproperty 
graphicLines:GraphicLines  [read-only] [override]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
graphicsproperty 
graphics:Graphics  [read-only] [override]

A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).


Implementation
    public function get graphics():Graphics
groupsproperty 
groups:Groups  [read-only] [override]

A collection of groups.


Implementation
    public function get groups():Groups
horizontalScaleproperty 
horizontalScale:Number[override]

The horizontal scaling applied to the Rectangle.


Implementation
    public function get horizontalScale():Number
    public function set horizontalScale(value:Number):void
idproperty 
id:Number  [read-only] [override]

The unique ID of the Rectangle.


Implementation
    public function get id():Number
imagesproperty 
images:Images  [read-only] [override]

A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).


Implementation
    public function get images():Images
importedPagesproperty 
importedPages:ImportedPages  [read-only] [override]

Imported InDesign pages.


Implementation
    public function get importedPages():ImportedPages
incopyExportOptionsproperty 
incopyExportOptions:InCopyExportOption  [read-only]

Export options for InCopy INCX document format.


Implementation
    public function get incopyExportOptions():InCopyExportOption
indexproperty 
index:Number  [read-only] [override]

The index of the Rectangle within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
itemLayerproperty 
itemLayer:Layer[override]

The layer that the Rectangle is on.


Implementation
    public function get itemLayer():Layer
    public function set itemLayer(value:Layer):void
labelproperty 
label:String[override]

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
leftLineEndproperty 
leftLineEnd:ArrowHead[override]

The arrowhead applied to the start of the path.


Implementation
    public function get leftLineEnd():ArrowHead
    public function set leftLineEnd(value:ArrowHead):void
localDisplaySettingproperty 
localDisplaySetting:DisplaySettingOptions[override]

Display performance options for the Rectangle.


Implementation
    public function get localDisplaySetting():DisplaySettingOptions
    public function set localDisplaySetting(value:DisplaySettingOptions):void
lockedproperty 
locked:Boolean[override]

If true, the Rectangle is locked.


Implementation
    public function get locked():Boolean
    public function set locked(value:Boolean):void
lockStateproperty 
lockState:LockStateValues  [read-only] [override]

The lock state.


Implementation
    public function get lockState():LockStateValues
mediaItemsproperty 
mediaItems:MediaItems  [read-only] [override]

The media items collection.


Implementation
    public function get mediaItems():MediaItems
miterLimitproperty 
miterLimit:Number[override]

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.


Implementation
    public function get miterLimit():Number
    public function set miterLimit(value:Number):void
moviesproperty 
movies:Movies  [read-only] [override]

A collection of movies.


Implementation
    public function get movies():Movies
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only] [override]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String[override]

The name of the Rectangle.


Implementation
    public function get name():String
    public function set name(value:String):void
nonprintingproperty 
nonprinting:Boolean[override]

If true, the Rectangle does not print.


Implementation
    public function get nonprinting():Boolean
    public function set nonprinting(value:Boolean):void
ovalsproperty 
ovals:Ovals  [read-only] [override]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
overprintFillproperty 
overprintFill:Boolean[override]

If true, the Rectangle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.


Implementation
    public function get overprintFill():Boolean
    public function set overprintFill(value:Boolean):void
overprintGapproperty 
overprintGap:Boolean[override]

If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.


Implementation
    public function get overprintGap():Boolean
    public function set overprintGap(value:Boolean):void
overprintStrokeproperty 
overprintStroke:Boolean[override]

If true, the Rectangle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.


Implementation
    public function get overprintStroke():Boolean
    public function set overprintStroke(value:Boolean):void
overriddenproperty 
overridden:Boolean  [read-only] [override]

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.


Implementation
    public function get overridden():Boolean
overriddenMasterPageItemproperty 
overriddenMasterPageItem:Object  [read-only] [override]

An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.


Implementation
    public function get overriddenMasterPageItem():Object
pageItemsproperty 
pageItems:PageItems  [read-only] [override]

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.


Implementation
    public function get pageItems():PageItems
parentproperty 
parent:Object  [read-only] [override]

The parent of the Rectangle (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).


Implementation
    public function get parent():Object
parentPageproperty 
parentPage:Page  [read-only] [override]

The page on which this page item appears.


Implementation
    public function get parentPage():Page
pathsproperty 
paths:Paths  [read-only] [override]

A collection of paths.


Implementation
    public function get paths():Paths
pdfsproperty 
pdfs:PDFs  [read-only] [override]

A collection of PDF files.


Implementation
    public function get pdfs():PDFs
pictsproperty 
picts:PICTs  [read-only] [override]

A collection of PICT graphics.


Implementation
    public function get picts():PICTs
polygonsproperty 
polygons:Polygons  [read-only] [override]

A collection of polygons.


Implementation
    public function get polygons():Polygons
preferencesproperty 
preferences:Preferences  [read-only] [override]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rectanglesproperty 
rectangles:Rectangles  [read-only] [override]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
rightLineEndproperty 
rightLineEnd:ArrowHead[override]

The arrowhead applied to the end of the path.


Implementation
    public function get rightLineEnd():ArrowHead
    public function set rightLineEnd(value:ArrowHead):void
rotationAngleproperty 
rotationAngle:Number[override]

The rotatation angle of the Rectangle. (Range: -360 to 360)


Implementation
    public function get rotationAngle():Number
    public function set rotationAngle(value:Number):void
shearAngleproperty 
shearAngle:Number[override]

The skewing angle applied to the Rectangle. (Range: -360 to 360)


Implementation
    public function get shearAngle():Number
    public function set shearAngle(value:Number):void
soundsproperty 
sounds:Sounds  [read-only] [override]

A collection of sound clips.


Implementation
    public function get sounds():Sounds
splineItemsproperty 
splineItems:SplineItems  [read-only] [override]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
storyTitleproperty 
storyTitle:String

Title for this InCopy story.


Implementation
    public function get storyTitle():String
    public function set storyTitle(value:String):void
strokeAlignmentproperty 
strokeAlignment:StrokeAlignment[override]

The stroke alignment applied to the Rectangle.


Implementation
    public function get strokeAlignment():StrokeAlignment
    public function set strokeAlignment(value:StrokeAlignment):void
strokeColorproperty 
strokeColor:Swatch[override]

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Rectangle. Can also accept: String.


Implementation
    public function get strokeColor():Swatch
    public function set strokeColor(value:Swatch):void
strokeCornerAdjustmentproperty 
strokeCornerAdjustment:StrokeCornerAdjustment[override]

The corner adjustment applied to the Rectangle.


Implementation
    public function get strokeCornerAdjustment():StrokeCornerAdjustment
    public function set strokeCornerAdjustment(value:StrokeCornerAdjustment):void
strokeDashAndGapproperty 
strokeDashAndGap:Object[override]

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


Implementation
    public function get strokeDashAndGap():Object
    public function set strokeDashAndGap(value:Object):void
strokeTintproperty 
strokeTint:Number[override]

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


Implementation
    public function get strokeTint():Number
    public function set strokeTint(value:Number):void
strokeTransparencySettingsproperty 
strokeTransparencySettings:StrokeTransparencySetting  [read-only] [override]

Transparency settings for the stroke.


Implementation
    public function get strokeTransparencySettings():StrokeTransparencySetting
strokeTypeproperty 
strokeType:StrokeStyle[override]

The name of the stroke style to apply. Can also accept: String.


Implementation
    public function get strokeType():StrokeStyle
    public function set strokeType(value:StrokeStyle):void
strokeWeightproperty 
strokeWeight:Object[override]

The weight (in points) to apply to the Rectangle's stroke.


Implementation
    public function get strokeWeight():Object
    public function set strokeWeight(value:Object):void
textFramesproperty 
textFrames:TextFrames  [read-only] [override]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
textPathsproperty 
textPaths:TextPaths  [read-only] [override]

A collection of text paths.


Implementation
    public function get textPaths():TextPaths
textWrapPreferencesproperty 
textWrapPreferences:TextWrapPreference  [read-only] [override]

The text wrap preference properties that define the default formatting for wrapping text around objects.


Implementation
    public function get textWrapPreferences():TextWrapPreference
timingSettingsproperty 
timingSettings:TimingSetting  [read-only] [override]

The object timing settings.


Implementation
    public function get timingSettings():TimingSetting
topLeftCornerOptionproperty 
topLeftCornerOption:CornerOptions[override]

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.


Implementation
    public function get topLeftCornerOption():CornerOptions
    public function set topLeftCornerOption(value:CornerOptions):void
topLeftCornerRadiusproperty 
topLeftCornerRadius:Object[override]

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes


Implementation
    public function get topLeftCornerRadius():Object
    public function set topLeftCornerRadius(value:Object):void
topRightCornerOptionproperty 
topRightCornerOption:CornerOptions[override]

The shape to apply to the top right corner of rectangular shapes


Implementation
    public function get topRightCornerOption():CornerOptions
    public function set topRightCornerOption(value:CornerOptions):void
topRightCornerRadiusproperty 
topRightCornerRadius:Object[override]

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes


Implementation
    public function get topRightCornerRadius():Object
    public function set topRightCornerRadius(value:Object):void
transparencySettingsproperty 
transparencySettings:TransparencySetting  [read-only] [override]

Transparency settings.


Implementation
    public function get transparencySettings():TransparencySetting
verticalScaleproperty 
verticalScale:Number[override]

The vertical scaling applied to the Rectangle.


Implementation
    public function get verticalScale():Number
    public function set verticalScale(value:Number):void
visibleproperty 
visible:Boolean[override]

If true, the Rectangle is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
visibleBoundsproperty 
visibleBounds:Object[override]

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.


Implementation
    public function get visibleBounds():Object
    public function set visibleBounds(value:Object):void
wmfsproperty 
wmfs:WMFs  [read-only] [override]

A collection of WMF graphics.


Implementation
    public function get wmfs():WMFs
Method Detail
addEventListenerRectangle()method
public function addEventListenerRectangle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
addPath()method 
override public function addPath(withParam:Array = null):PageItem

Creates a new page item by combining the Rectangle with other objects. Deletes the objects if they do not intersect.

Parameters

withParam:Array (default = null) — (Array) The object(s) to add.

Returns
PageItem
applyObjectStyle()method 
override public function applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void

Applies the specified object style.

Parameters

usingParam:ObjectStyle (default = null) — (ObjectStyle) The object style to apply.
 
clearingOverridesParam:Boolean (default = true) — (Boolean) If true, clears the Rectangle's existing attributes before applying the style. (Optional)
 
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false) — (Boolean) If true, clears attributes and formatting applied to the Rectangle that are not defined in the object style. (Optional)

asynchronousExportFile()method 
override public function asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask

asynchronously exports the object(s) to a file.

Parameters

formatParam:Object (default = null) — (Object) 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.
 
toParam:File (default = null) — (File) The path to the export file.
 
showingOptionsParam:Boolean (default = false) — (Boolean) If true, displays the export options dialog. (Optional)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
BackgroundTask
autoTag()method 
override public function autoTag():void

Tag the object or the parent story using default tags defined in XML preference.

bringForward()method 
override public function bringForward():void

Brings the Rectangle forward one level in its layer.

bringToFront()method 
override public function bringToFront(referenceParam:PageItem = null):void

Brings the Rectangle to the front of its layer or in front of a particular item.

Parameters

referenceParam:PageItem (default = null) — (PageItem) The reference object to bring the object in front of (must have same parent) (Optional)

changeObject()method 
override public function changeObject(reverseOrderParam:Boolean):Object

Finds objects that match the find what value and replace the objects with the change to value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
checkIn()method 
override public function checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean

Checks in the story or stories.

Parameters

versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
Boolean
checkOut()method 
override public function checkOut():Boolean

Checks out the story.

Returns
Boolean
clearFrameFittingOptions()method 
public function clearFrameFittingOptions():void

Removes the frame fittings options and resets it to the initial state.

clearObjectStyleOverrides()method 
override public function clearObjectStyleOverrides():void

Clear overrides for object style

clearTransformations()method 
override public function clearTransformations():void

Clears transformations from the Rectangle. Transformations include rotation, scaling, flipping, fitting, and shearing.

convertShape()method 
override public function convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void

Converts the Rectangle to a different shape.

Parameters

givenParam:ConvertShapeOptions (default = null) — (ConvertShapeOptions) The Rectangle's new shape.
 
numberOfSidesParam:Number (default = NaN) — (Number) The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
 
insetPercentageParam:Number (default = NaN) — (Number) The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
 
cornerRadiusParam:Object (default = null) — (Object) The corner radius of the resulting rectangle. (Optional)

detach()method 
override public function detach():void

Detaches an overridden master page item from the master page.

duplicate()method 
override public function duplicate(toParam:Object = null, byParam:Array = null):PageItem

Duplicates the Rectangle at the specified location or offset.

Parameters

toParam:Object (default = null) — (Object) 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)
 
byParam:Array (default = null) — (Array) Amount by which to offset the new Rectangle from the original Rectangle's position. (Optional)

Returns
PageItem
excludeOverlapPath()method 
override public function excludeOverlapPath(withParam:Array = null):PageItem

Creates a new page item by excluding the overlapping areas of the Rectangle and other objects.

Parameters

withParam:Array (default = null) — (Array) The object(s) to exclude.

Returns
PageItem
exportFile()method 
override public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Exports the object(s) to a file.

Parameters

formatParam:Object (default = null) — (Object) 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.
 
toParam:File (default = null) — (File) The path to the export file.
 
showingOptionsParam:Boolean (default = false) — (Boolean) If true, displays the export options dialog. (Optional)
 
usingParam:PDFExportPreset (default = null) — (PDFExportPreset) The export style. (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

extractLabel()method 
override public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
findObject()method 
override public function findObject(reverseOrderParam:Boolean):Object

Finds objects that match the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
fit()method 
override public function fit(givenParam:FitOptions = null):void

Applies the specified fit option to content in a frame.

Parameters

givenParam:FitOptions (default = null) — (FitOptions) The fit option to use.

flipItem()method 
override public function flipItem(givenParam:Flip = null, aroundParam:Object = null):void

Flips the Rectangle.

Parameters

givenParam:Flip (default = null) — (Flip) The axis around which to flip the Rectangle.
 
aroundParam:Object (default = null) — (Object) The point around which to flip the Rectangle. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

getElements()method 
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
override public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

intersectPath()method 
override public function intersectPath(withParam:Array = null):PageItem

Creates a new page item by intersecting the Rectangle with other objects. Returns an error if the objects do not intersect.

Parameters

withParam:Array (default = null) — (Array) The object(s) with which to intersect.

Returns
PageItem
makeCompoundPath()method 
override public function makeCompoundPath(withParam:Array = null):PageItem

Creates a compound path by combining the path(s) of the Rectangle with the paths of other objects.

Parameters

withParam:Array (default = null) — (Array) The other objects whose paths to include in the new compound path.

Returns
PageItem
markup()method 
override public function markup(usingParam:XMLElement = null):void

Associates the page item with the specified XML element while preserving existing content.

Parameters

usingParam:XMLElement (default = null) — (XMLElement) The XML element.

minusBack()method 
override public function minusBack(withParam:Array = null):PageItem

Creates a new page item by reverse subtracting the overlapping areas of the Rectangle and other objects.

Parameters

withParam:Array (default = null) — (Array) The object(s) to reverse subtract.

Returns
PageItem
move()method 
override public function move(toParam:Object = null, byParam:Array = null):void

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.

Parameters

toParam:Object (default = null) — (Object) The new location of the Rectangle,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
 
byParam:Array (default = null) — (Array) The amount (in measurement units) to move the Rectangle relative to its current position, in the format (x, y). (Optional)

override()method 
override public function override(destinationPageParam:Page = null):Object

Overrides a master page item and places the item on the document page as a new object.

Parameters

destinationPageParam:Page (default = null) — (Page) The document page that contains the master page item to override.

Returns
Object
place()method 
override public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object

Places the file.

Parameters

fileNameParam:File (default = null) — (File) The file to place
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the placed object(s) (Optional)

Returns
Object
placeXML()method 
override public function placeXML(usingParam:XMLElement = null):void

Places XML content into the specified object. Note: Replaces any existing content.

Parameters

usingParam:XMLElement (default = null) — (XMLElement) The XML element whose content you want to place.

redefineScaling()method 
override public function redefineScaling(toParam:Array = null):void

Apply an item's scaling to its content if possible.

Parameters

toParam:Array (default = null) — (Array) The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

reframe()method 
override public function reframe(inParam:Object = null, opposingCornersParam:Array = null):void

Move the bounding box of the page item

Parameters

inParam:Object (default = null) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
 
opposingCornersParam:Array (default = null) — (Array) Opposing corners of new bounding box in the given coordinate space

releaseCompoundPath()method 
override public function releaseCompoundPath():Object

Releases a compound path.

Returns
Object
remove()method 
override public function remove():void

Deletes the Rectangle.

removeEventListenerRectangle()method 
public function removeEventListenerRectangle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
removeOverride()method 
override public function removeOverride():void

Removes the override from a previously overridden master page item.

resize()method 
override public function resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void

Resize the page item.

Parameters

inParam:Object (default = null) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
 
fromParam:Object (default = null) — (Object) The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
byParam:ResizeMethods (default = null) — (ResizeMethods) How the current dimensions are affected by the given values
 
valuesParam:Array (default = null) — (Array) The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
 
resizeIndividuallyParam:Boolean (default = true) — (Boolean) If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) 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)

resolve()method 
override public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object

Get the coordinates of the given location in the specified coordinate system.

Parameters

locationParam:Object (default = null) — (Object) 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.
 
inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use.
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) 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)

Returns
Object
revert()method 
override public function revert():Boolean

Reverts the document to its state at the last save operation.

Returns
Boolean
select()method 
override public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the Rectangle in relation to previously selected objects. (Optional)

sendBackward()method 
override public function sendBackward():void

Sends the Rectangle back one level in its layer.

sendToBack()method 
override public function sendToBack(referenceParam:PageItem = null):void

Sends the Rectangle to the back of its layer or behind a particular item (must have same parent).

Parameters

referenceParam:PageItem (default = null) — (PageItem) The reference object to send the object behind (Optional)

store()method 
override public function store(usingParam:Library = null, withPropertiesParam:Object = null):Asset

Stores the object in the specified library.

Parameters

usingParam:Library (default = null) — (Library) The library in which to store the object.
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new Rectangle (Optional)

Returns
Asset
subtractPath()method 
override public function subtractPath(withParam:Array = null):PageItem

Creates a new page item by subtracting the overlapping areas of the Rectangle and other objects.

Parameters

withParam:Array (default = null) — (Array) The object(s) to subtract.

Returns
PageItem
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String
transform()method 
override public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void

Transform the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use
 
fromParam:Object (default = null) — (Object) 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.
 
withMatrixParam:Object (default = null) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
 
replacingCurrentParam:Object (default = null) — (Object) 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)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) 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)

transformAgain()method 
override public function transformAgain():Object

Transforms the Rectangle using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Returns
Object
transformAgainIndividually()method 
override public function transformAgainIndividually():Object

Transforms the Rectangle using the last transformation performed on any Rectangle. Transformations include moving, rotating, shearing, scaling, and flipping.

Returns
Object
transformSequenceAgain()method 
override public function transformSequenceAgain():Object

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.

Returns
Object
transformSequenceAgainIndividually()method 
override public function transformSequenceAgainIndividually():Object

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.

Returns
Object
transformValuesOf()method 
override public function transformValuesOf(inParam:CoordinateSpaces = null):Object

Get the transformation values of the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use

Returns
Object