| Property | Type | Access | Description |
| absoluteFlip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | Indicates whether the FormField has been flipped independently of its parent object and, if yes, the direction in which the FormField was flipped. |
| absoluteHorizontalScale | number |
r/w | The horizontal scale of the FormField relative to its containing object. |
| absoluteRotationAngle | number |
r/w | The rotation angle of the FormField relative to its containing object. (Range: -360 to 360) |
| absoluteShearAngle | number |
r/w | The skewing angle of the FormField relative to its containing object. (Range: -360 to 360) |
| absoluteVerticalScale | number |
r/w | The vertical scale of the FormField relative to its containing object. |
| activeStateIndex | number |
r/w | The index of the active state in the object's states collection. |
| allArticles | Array of Article |
readonly | The list of all articles this page item is part of |
| allGraphics | Array of Graphic |
readonly | Lists all graphics contained by the FormField. |
| allPageItems | Array of PageItem |
readonly | Lists all page items contained by the FormField. |
| allowOverrides | bool |
r/w | If true, the master page item can be overridden. |
| anchoredObjectSettings | AnchoredObjectSetting |
readonly | Anchored object settings. |
| animationSettings | AnimationSetting |
readonly | The page item animation settings. |
| appliedObjectStyle | ObjectStyle |
r/w | The object style applied to the FormField. |
| associatedXMLElement | XMLItem |
readonly | The XML element associated with the FormField. |
| bottomLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom left corner of rectangular shapes. |
| bottomLeftCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
| bottomRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom right corner of rectangular shapes. |
| bottomRightCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
| contentTransparencySettings | ContentTransparencySetting |
readonly | Transparency settings for the content of the FormField. |
| description | string |
r/w | The description of the FormField. |
| endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
r/w | The end shape of an open path. |
| endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
r/w | The corner join applied to the FormField. |
| eventListeners | EventListeners EventListener |
readonly | A collection of event listeners. |
| events | Events Event |
readonly | A collection of events. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the FormField. . Can also accept: String. |
| fillTint | number |
r/w | 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.) |
| fillTransparencySettings | FillTransparencySetting |
readonly | Transparency settings for the fill applied to the FormField. |
| flip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | The direction in which to flip the printed image. |
| gapColor | Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. |
| gapTint | number |
r/w | The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
| geometricBounds | Array of Measurement Unit (Number or String) |
r/w | 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. |
| gradientFillAngle | number |
r/w | The angle of a linear gradient applied to the fill of the FormField. (Range: -180 to 180) |
| gradientFillLength | Measurement Unit (Number or String) |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the FormField. |
| gradientFillStart | Array of Measurement Unit (Number or String) |
r/w | The starting point (in page coordinates) of a gradient applied to the fill of the FormField, in the format [x, y]. |
| gradientStrokeAngle | number |
r/w | The angle of a linear gradient applied to the stroke of the FormField. (Range: -180 to 180) |
| gradientStrokeLength | Measurement Unit (Number or String) |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the FormField. |
| gradientStrokeStart | Array of Measurement Unit (Number or String) |
r/w | The starting point (in page coordinates) of a gradient applied to the stroke of the FormField, in the format [x, y]. |
| horizontalLayoutConstraints | Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
r/w | The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. |
| horizontalScale | number |
r/w | The horizontal scaling applied to the FormField. |
| id | number |
readonly | The unique ID of the FormField. |
| index | number |
readonly | The index of the FormField within its containing object. |
| isValid | bool |
readonly | Returns true if the object specifier resolves to valid objects. |
| itemLayer | Layer |
r/w | The layer that the FormField is on. |
| label | string |
r/w | A property that can be set to any string. |
| leftLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the start of the path. |
| linkedPageItemOptions | LinkedPageItemOption |
readonly | Linked Page Item options |
| locked | bool |
r/w | If true, the FormField is locked. |
| miterLimit | number (range: 1 - 500) |
r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4) |
| name | string |
r/w | The name of the FormField. |
| nonprinting | bool |
r/w | If true, the FormField does not print. |
| overprintFill | bool |
r/w | If true, the FormField's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
| overprintGap | bool |
r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
| overprintStroke | bool |
r/w | If true, the FormField's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
| overridden | bool |
readonly | If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page. |
| overriddenMasterPageItem | Graphic Guide Movie PageItem Sound |
readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
| parent | Character GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle Snippet SplineItem Spread |
readonly | The parent of the FormField (a PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, Character or Snippet). |
| parentPage | Page |
readonly | The page on which this page item appears. |
| preferences | Preferences Preference |
readonly | A collection of preferences objects. |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
| rightLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the end of the path. |
| rotationAngle | number |
r/w | The rotatation angle of the FormField. (Range: -360 to 360) |
| shearAngle | number |
r/w | The skewing angle applied to the FormField. (Range: -360 to 360) |
| strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the FormField. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the FormField. Can also accept: String. |
| strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the FormField. |
| strokeDashAndGap | Array of Measurement Unit (Number or String) |
r/w | The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. |
| strokeTint | number |
r/w | The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
| strokeTransparencySettings | StrokeTransparencySetting |
readonly | Transparency settings for the stroke. |
| strokeType | String StrokeStyle |
r/w | The name of the stroke style to apply. Can also accept: String. |
| strokeWeight | Measurement Unit (Number or String) |
r/w | The weight (in points) to apply to the FormField's stroke. |
| textWrapPreferences | TextWrapPreference |
readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. |
| timingSettings | TimingSetting |
readonly | The object timing settings. |
| topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | 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. |
| topLeftCornerRadius | Measurement Unit (Number or String) |
r/w | 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 |
| topRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the top right corner of rectangular shapes |
| topRightCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
| transparencySettings | TransparencySetting |
readonly | Transparency settings. |
| verticalLayoutConstraints | Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
r/w | The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. |
| verticalScale | number |
r/w | The vertical scaling applied to the FormField. |
| visible | bool |
r/w | If true, the FormField is visible. |
| visibleBounds | Array of Measurement Unit (Number or String) |
r/w | 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. |