Packagecom.adobe.indesign
Classpublic class FormField
InheritanceFormField Inheritance PageItem Inheritance CSHostObject Inheritance flash.utils.Proxy
Subclasses Button, MultiStateObject

PageItem



Public Properties
 PropertyDefined By
  absoluteFlip : Flip
[override] Indicates whether the FormField has been flipped independently of its parent object and, if yes, the direction in which the FormField was flipped.
FormField
  absoluteHorizontalScale : Number
[override] The horizontal scale of the FormField relative to its containing object.
FormField
  absoluteRotationAngle : Number
[override] The rotation angle of the FormField relative to its containing object.
FormField
  absoluteShearAngle : Number
[override] The skewing angle of the FormField relative to its containing object.
FormField
  absoluteVerticalScale : Number
[override] The vertical scale of the FormField relative to its containing object.
FormField
  activeStateIndex : Number
The index of the active state in the object's states collection.
FormField
  AFTER_PLACE : String
[static] [read-only] Dispatched after a FormField is placed.
FormField
  allGraphics : Object
[override] [read-only] Lists all graphics contained by the FormField.
FormField
  allowOverrides : Boolean
[override] If true, the master page item can be overridden.
FormField
  allPageItems : Object
[override] [read-only] Lists all page items contained by the FormField.
FormField
  anchoredObjectSettings : AnchoredObjectSetting
[read-only] Anchored object settings.
FormField
  animationSettings : AnimationSetting
[override] [read-only] The page item animation settings.
FormField
  appliedObjectStyle : ObjectStyle
[override] The object style applied to the FormField.
FormField
  associatedXMLElement : XMLItem
[override] [read-only] The XML element associated with the FormField.
FormField
  BEFORE_PLACE : String
[static] [read-only] Dispatched before a FormField is placed.
FormField
  bottomLeftCornerOption : CornerOptions
[override] The shape to apply to the bottom left corner of rectangular shapes.
FormField
  bottomLeftCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
FormField
  bottomRightCornerOption : CornerOptions
[override] The shape to apply to the bottom right corner of rectangular shapes.
FormField
  bottomRightCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
FormField
  contentTransparencySettings : ContentTransparencySetting
[override] [read-only] Transparency settings for the content of the FormField.
FormField
  description : String
The description of the FormField.
FormField
  endCap : EndCap
[override] The end shape of an open path.
FormField
  endJoin : EndJoin
[override] The corner join applied to the FormField.
FormField
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
FormField
  events : Events
[override] [read-only] A collection of events.
FormField
  fillColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the fill of the FormField.
FormField
  fillTint : Number
[override] The percent of tint to use in the FormField's fill color.
FormField
  fillTransparencySettings : FillTransparencySetting
[override] [read-only] Transparency settings for the fill applied to the FormField.
FormField
  flip : Flip
[override] The direction in which to flip the printed image.
FormField
  gapColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke.
FormField
  gapTint : Number
[override] The tint as a percentage of the gap color.
FormField
  geometricBounds : Object
[override] The bounds of the FormField 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.
FormField
  gradientFillAngle : Number
[override] The angle of a linear gradient applied to the fill of the FormField.
FormField
  gradientFillLength : Object
[override] The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the FormField.
FormField
  gradientFillStart : Object
[override] The starting point (in page coordinates) of a gradient applied to the fill of the FormField, in the format [x, y].
FormField
  gradientStrokeAngle : Number
[override] The angle of a linear gradient applied to the stroke of the FormField.
FormField
  gradientStrokeLength : Object
[override] The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the FormField.
FormField
  gradientStrokeStart : Object
[override] The starting point (in page coordinates) of a gradient applied to the stroke of the FormField, in the format [x, y].
FormField
  horizontalScale : Number
[override] The horizontal scaling applied to the FormField.
FormField
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[override] [read-only] The unique ID of the FormField.
FormField
  index : Number
[override] [read-only] The index of the FormField within its containing object.
FormField
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
FormField
  itemLayer : Layer
[override] The layer that the FormField is on.
FormField
  label : String
[override] A property that can be set to any string.
FormField
  leftLineEnd : ArrowHead
[override] The arrowhead applied to the start of the path.
FormField
  localDisplaySetting : DisplaySettingOptions
[override] Display performance options for the FormField.
FormField
  locked : Boolean
[override] If true, the FormField is locked.
FormField
  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.
FormField
  name : String
[override] The name of the FormField.
FormField
  nonprinting : Boolean
[override] If true, the FormField does not print.
FormField
  overprintFill : Boolean
[override] If true, the FormField's fill color overprints any underlying objects.
FormField
  overprintGap : Boolean
[override] If true, the gap color overprints any underlying colors.
FormField
  overprintStroke : Boolean
[override] If true, the FormField's stroke color overprints any underlying objects.
FormField
  overridden : Boolean
[override] [read-only] If true, the object originated on a master spread and was overridden.
FormField
  overriddenMasterPageItem : Object
[override] [read-only] An object that originated on a master page and has been overridden.
FormField
  parent : Object
[override] [read-only] The parent of the FormField (a PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, Character or Snippet).
FormField
  parentPage : Page
[override] [read-only] The page on which this page item appears.
FormField
  preferences : Preferences
[override] [read-only] A collection of preferences objects.
FormField
  properties : Object
[override] A property that allows setting of several properties at the same time.
FormField
  rightLineEnd : ArrowHead
[override] The arrowhead applied to the end of the path.
FormField
  rotationAngle : Number
[override] The rotatation angle of the FormField.
FormField
  shearAngle : Number
[override] The skewing angle applied to the FormField.
FormField
  strokeAlignment : StrokeAlignment
[override] The stroke alignment applied to the FormField.
FormField
  strokeColor : Swatch
[override] The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FormField.
FormField
  strokeCornerAdjustment : StrokeCornerAdjustment
[override] The corner adjustment applied to the FormField.
FormField
  strokeDashAndGap : Object
[override] The dash and gap measurements that define the pattern of a custom dashed line.
FormField
  strokeTint : Number
[override] The percent of tint to use in object's stroke color.
FormField
  strokeTransparencySettings : StrokeTransparencySetting
[override] [read-only] Transparency settings for the stroke.
FormField
  strokeType : StrokeStyle
[override] The name of the stroke style to apply.
FormField
  strokeWeight : Object
[override] The weight (in points) to apply to the FormField's stroke.
FormField
  textWrapPreferences : TextWrapPreference
[override] [read-only] The text wrap preference properties that define the default formatting for wrapping text around objects.
FormField
  timingSettings : TimingSetting
[override] [read-only] The object timing settings.
FormField
  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.
FormField
  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
FormField
  topRightCornerOption : CornerOptions
[override] The shape to apply to the top right corner of rectangular shapes
FormField
  topRightCornerRadius : Object
[override] The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
FormField
  transparencySettings : TransparencySetting
[override] [read-only] Transparency settings.
FormField
  verticalScale : Number
[override] The vertical scaling applied to the FormField.
FormField
  visible : Boolean
[override] If true, the FormField is visible.
FormField
  visibleBounds : Object
[override] The bounds of the FormField 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.
FormField
Public Methods
 MethodDefined By
  
addEventListenerFormField(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
FormField
 Inherited
addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PageItem
  
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
[override] Applies the specified object style.
FormField
  
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.
FormField
  
autoTag():void
[override] Tag the object or the parent story using default tags defined in XML preference.
FormField
  
changeObject(reverseOrderParam:Boolean):Object
[override] Finds objects that match the find what value and replace the objects with the change to value.
FormField
  
[override] Clear overrides for object style
FormField
  
[override] Clears transformations from the FormField.
FormField
  
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
[override] Converts the FormField to a different shape.
FormField
  
detach():void
[override] Detaches an overridden master page item from the master page.
FormField
  
duplicate(toParam:Object = null, byParam:Array = null):PageItem
[override] Duplicates the FormField at the specified location or offset.
FormField
  
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.
FormField
  
extractLabel(keyParam:String = null):String
[override] Gets the label value associated with the specified key.
FormField
 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.
FormField
  
fit(givenParam:FitOptions = null):void
[override] Applies the specified fit option to content in a frame.
FormField
  
flipItem(givenParam:Flip = null, aroundParam:Object = null):void
[override] Flips the FormField.
FormField
 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.
FormField
 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.
FormField
 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
  
markup(usingParam:XMLElement = null):void
[override] Associates the page item with the specified XML element while preserving existing content.
FormField
  
move(toParam:Object = null, byParam:Array = null):void
[override] Moves the FormField to a new location.
FormField
  
override(destinationPageParam:Page = null):Object
[override] Overrides a master page item and places the item on the document page as a new object.
FormField
 Inherited
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file.
PageItem
  
placeXML(usingParam:XMLElement = null):void
[override] Places XML content into the specified object.
FormField
  
redefineScaling(toParam:Array = null):void
[override] Apply an item's scaling to its content if possible.
FormField
  
reframe(inParam:Object = null, opposingCornersParam:Array = null):void
[override] Move the bounding box of the page item
FormField
  
remove():void
[override] Deletes the FormField.
FormField
  
removeEventListenerFormField(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
FormField
 Inherited
removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PageItem
  
[override] Removes the override from a previously overridden master page item.
FormField
 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.
FormField
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
[override] Get the coordinates of the given location in the specified coordinate system.
FormField
  
select(existingSelectionParam:SelectionOptions = null):void
[override] Selects the object.
FormField
  
store(usingParam:Library = null, withPropertiesParam:Object = null):Asset
[override] Stores the object in the specified library.
FormField
  
toSpecifier():String
[override] Retrieves the object specifier.
FormField
  
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
[override] Transform the page item.
FormField
  
[override] Transforms the FormField using the last transformation performed on any object.
FormField
  
[override] Transforms the FormField using the last transformation performed on any FormField.
FormField
  
[override] Transforms the FormField using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects.
FormField
  
[override] Transforms the FormField using the last sequence of transformations performed on any single object or performed at the same time on any group of objects.
FormField
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
[override] Get the transformation values of the page item.
FormField
 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 FormField has been flipped independently of its parent object and, if yes, the direction in which the FormField was flipped.


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

The horizontal scale of the FormField 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 FormField 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 FormField 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 FormField relative to its containing object.


Implementation
    public function get absoluteVerticalScale():Number
    public function set absoluteVerticalScale(value:Number):void
activeStateIndexproperty 
activeStateIndex:Number

The index of the active state in the object's states collection.


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

Dispatched after a FormField 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 FormField.


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


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

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


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


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

Dispatched before a FormField 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
contentTransparencySettingsproperty 
contentTransparencySettings:ContentTransparencySetting  [read-only] [override]

Transparency settings for the content of the FormField.


Implementation
    public function get contentTransparencySettings():ContentTransparencySetting
descriptionproperty 
description:String

The description of the FormField.


Implementation
    public function get description():String
    public function set description(value:String):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 FormField.


Implementation
    public function get endJoin():EndJoin
    public function set endJoin(value:EndJoin):void
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 FormField. . 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 FormField'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 FormField.


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
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 FormField 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 FormField. (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 FormField.


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 FormField, 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 FormField. (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 FormField.


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 FormField, in the format [x, y].


Implementation
    public function get gradientStrokeStart():Object
    public function set gradientStrokeStart(value:Object):void
horizontalScaleproperty 
horizontalScale:Number[override]

The horizontal scaling applied to the FormField.


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

The unique ID of the FormField.


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

The index of the FormField 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 FormField 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 FormField.


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

If true, the FormField is locked.


Implementation
    public function get locked():Boolean
    public function set locked(value:Boolean):void
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
nameproperty 
name:String[override]

The name of the FormField.


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

If true, the FormField does not print.


Implementation
    public function get nonprinting():Boolean
    public function set nonprinting(value:Boolean):void
overprintFillproperty 
overprintFill:Boolean[override]

If true, the FormField'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 FormField'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
parentproperty 
parent:Object  [read-only] [override]

The parent of the FormField (a PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, Character 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
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
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 FormField. (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 FormField. (Range: -360 to 360)


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

The stroke alignment applied to the FormField.


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


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 FormField's stroke.


Implementation
    public function get strokeWeight():Object
    public function set strokeWeight(value:Object):void
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 FormField.


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

If true, the FormField is visible.


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

The bounds of the FormField 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
Method Detail
addEventListenerFormField()method
public function addEventListenerFormField(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
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 FormField's existing attributes before applying the style. (Optional)
 
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false) — (Boolean) If true, clears attributes and formatting applied to the FormField 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.

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
clearObjectStyleOverrides()method 
override public function clearObjectStyleOverrides():void

Clear overrides for object style

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

Clears transformations from the FormField. 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 FormField to a different shape.

Parameters

givenParam:ConvertShapeOptions (default = null) — (ConvertShapeOptions) The FormField'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 FormField at the specified location or offset.

Parameters

toParam:Object (default = null) — (Object) The location of the new FormField, 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 FormField from the original FormField's position. (Optional)

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

Parameters

givenParam:Flip (default = null) — (Flip) The axis around which to flip the FormField.
 
aroundParam:Object (default = null) — (Object) The point around which to flip the FormField. 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.

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.

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

Moves the FormField 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 FormField,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 FormField 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
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

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

Deletes the FormField.

removeEventListenerFormField()method 
public function removeEventListenerFormField(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
select()method 
override public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the FormField in relation to previously selected objects. (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 FormField (Optional)

Returns
Asset
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 FormField 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 FormField using the last transformation performed on any FormField. Transformations include moving, rotating, shearing, scaling, and flipping.

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

Transforms the FormField 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 FormField 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